Commit 84b64b61 authored by Lukas Riedel's avatar Lukas Riedel Committed by Santiago Ospina De Los Ríos

Update contribution guide

* Outline GitLab workflow.
* Add information on how to get an account.
* Mention Code of Conduct.
parent e967f24d
# Contribution Guide
# Contributing to DORiE
We encourage everyone to contribute to the development and improvement of DORIE.
**Thank you for taking your time and contributing to DORiE!** :+1:
Please notice our included [Code of Conduct](CODE_OF_CONDUCT.md).
## Code of Conduct
### Restricted Access to Repository
Everybody participating in and contributing to this project is expected to
uphold our attached [Code of Conduct](CODE_OF_CONDUCT.md). Report any
unacceptable behavior to the [DORiE Developers][mailinglist]!
Free access to the [GitLab instance](https://ts-gitlab.iup.uni-heidelberg.de) of
the [TS-CCEES group](http://ts.iup.uni-heidelberg.de/) at the
[Institute of Environmental Physics](http://www.iup.uni-heidelberg.de/) is
restricted to members of said group.
Non-members are left with read-only access to public repositories.
## How to Contribute
### How to Contribute
DORiE is open source software. We strive for making every stage of development
public, sharing our advances, and incorporating community contributions. We
therefore prefer public contributions of any kind via GitLab.
If you would like to _actively contribute_ to DORiE, and you are affiliated
with [Heidelberg University](http://www.uni-heidelberg.de/) or an associated
research institute, you can become a member of the DORiE development team.
### GitLab Account
Otherwise, we encourage you to contribute bug reports, feature requests, or
improvement suggestions by contacting the development team
[via mail](mailto:dorieteam@iup.uni-heidelberg.de).
The DORiE repository is hosted on the private GitLab instance of the
[TS-CCEES](http://ts.iup.uni-heidelberg.de/) research group at the
[Institute of Environmental Physics (IUP) Heidelberg](http://www.iup.uni-heidelberg.de/).
As we want to keep most of our projects private, we disabled the regular
sign-up procedure. If you are not a member of said research group, we encourage
you to request an account [via mail][mailinglist]. Notice that you will only
receive an account flagged as
"[External User](https://docs.gitlab.com/ee/user/permissions.html#external-users-core-only)"
in this case, with access to the DORiE repository only.
Notice, however, that resources for development and support are streched thin:
_Your mileage may vary._
\ No newline at end of file
### Issues and Merge Requests
Report bugs, suggest features, or plan implementations in GitLab Issues. We
provide several Description Templates you may find useful for structuring
your Issue description and providing the required information.
Any changes to source code should be accompanied by a (unit) test verifying the
functionality. Designing this test ideally happens in the planning phase of
a change.
After a proper discussion of the Issue, and the resulting implementation, open
a Merge Request. Again, we encourage you to use one of the Description
Templates. Provide information on how your code changes and additions solve the
problem or implement the feature. Make sure that your MR fulfills the the
criteria for being merged.
### Old-Fashioned Email
Of course, you can always contact the developers directly
[via mail][mailinglist].
[mailinglist]: mailto:dorieteam@iup.uni-heidelberg.de
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment