CONTRIBUTING.md 2.07 KB
Newer Older
Lukas Riedel's avatar
Lukas Riedel committed
1
# Contributing to DORiE
Lukas Riedel's avatar
Lukas Riedel committed
2

Lukas Riedel's avatar
Lukas Riedel committed
3
**Thank you for taking your time and contributing to DORiE!** :+1:
Lukas Riedel's avatar
Lukas Riedel committed
4

Lukas Riedel's avatar
Lukas Riedel committed
5
## Code of Conduct
Lukas Riedel's avatar
Lukas Riedel committed
6

Lukas Riedel's avatar
Lukas Riedel committed
7 8 9
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]!
Lukas Riedel's avatar
Lukas Riedel committed
10

Lukas Riedel's avatar
Lukas Riedel committed
11
## How to Contribute
Lukas Riedel's avatar
Lukas Riedel committed
12

Lukas Riedel's avatar
Lukas Riedel committed
13 14 15
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.
Lukas Riedel's avatar
Lukas Riedel committed
16

Lukas Riedel's avatar
Lukas Riedel committed
17
### GitLab Account
Lukas Riedel's avatar
Lukas Riedel committed
18

Lukas Riedel's avatar
Lukas Riedel committed
19 20 21 22 23 24 25 26 27
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.
Lukas Riedel's avatar
Lukas Riedel committed
28

Lukas Riedel's avatar
Lukas Riedel committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
### 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