Skip to content

Commit dcbd65a

Browse files
committed
Added contribution guide
1 parent d9f6fe9 commit dcbd65a

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contribution Guide
2+
3+
We follow the GitHub [Fork & Pull][forkandpull] and [Git Flow][gitflow] workflow in this project.
4+
Please fork the official repository, develop in a branch based on the
5+
current develop branch, and submit a pull request (PR) after you are done.
6+
7+
[forkandpull]: https://help.github.com/articles/about-pull-requests/
8+
[gitflow]: http://nvie.com/posts/a-successful-git-branching-model/
9+
10+
## Checklist before submitting a Pull Request
11+
12+
Before you submit your PR, please go through this list and check if
13+
your request fulfills these points.
14+
15+
- Do you have more changes/additions/deletions in your PR than you expected?
16+
- Do you have tests for your changes?
17+
- Do all tests of the project succeed?
18+
- Is your pull request based on the `develop` branch? [(cf. GitFlow)][gitflow]
19+
20+
If you check these items before, your pull request is more likely to be
21+
included into the project quickly.
22+

0 commit comments

Comments
 (0)