diff options
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING b/.github/CONTRIBUTING new file mode 100644 index 0000000..e9d9f41 --- /dev/null +++ b/.github/CONTRIBUTING @@ -0,0 +1,21 @@ +CONTRIBUTING +------------ + +Want to contribute? Great! First, read this page. + +Code reviews: +- All submissions, including submissions by project members, require review. We + use Github pull requests for this purpose. + +Some tips for good pull requests: +- Use our code + When in doubt, try to stay true to the existing code of the project. +- Write a descriptive commit message. What problem are you solving and what + are the consequences? Where and what did you test? Some good tips: + [here](http://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message) + and [here](https://www.kernel.org/doc/Documentation/SubmittingPatches). +- If your PR consists of multiple commits which are successive improvements / + fixes to your first commit, consider squashing them into a single commit + (`git rebase -i`) such that your PR is a single commit on top of the current + HEAD. This make reviewing the code so much easier, and our history more + readable. |