|
a |
|
b/contributing.md |
|
|
1 |
Contributing |
|
|
2 |
============ |
|
|
3 |
If you want to contribute to Segmentator and make it better, your help is very welcome. |
|
|
4 |
|
|
|
5 |
## Opening an issue |
|
|
6 |
|
|
|
7 |
- Please post your quesions, bug reports and feature requests [here](https://github.com/ofgulban/segmentator/issues). |
|
|
8 |
- When reporting a bug, please specify your system and a complete copy of the error message that you are getting. |
|
|
9 |
|
|
|
10 |
## Making a pull request |
|
|
11 |
|
|
|
12 |
- Create a personal fork of the project on Github. |
|
|
13 |
- Clone the fork on your local machine. |
|
|
14 |
- Create a new branch to work on. Branch from `devel`. |
|
|
15 |
- Implement/fix your feature, comment your code. |
|
|
16 |
- Follow the code style of the project. |
|
|
17 |
- Add or change the documentation as needed. |
|
|
18 |
- Push your branch to your fork on Github. |
|
|
19 |
- From your fork open a pull request in the correct branch. Target `devel` branch of the original Segmentator repository. |
|
|
20 |
|
|
|
21 |
__Note:__ Please write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code. |
|
|
22 |
|
|
|
23 |
___ |
|
|
24 |
This guideline is adapted from [link](https://github.com/MarcDiethelm/contributing/blob/master/README.md) |