diff options
author | Lasse Schuirmann <lasse.schuirmann@gmail.com> | 2015-09-22 23:21:20 +0200 |
---|---|---|
committer | Lasse Schuirmann <lasse.schuirmann@gmail.com> | 2015-09-22 23:22:40 +0200 |
commit | 1174bff582e4a8c41bec10b7114aa202a32c6b48 (patch) | |
tree | d8e85e70cd352eaae962a417f1f752cc1c87271f /CONTRIBUTING.md | |
parent | 26602f3a52f68a0593e33dd2007ab0b050852e08 (diff) | |
download | babel-1174bff582e4a8c41bec10b7114aa202a32c6b48.tar.gz |
Add CONTRIBUTINGsils/contributing
This finally fixes our review process and gives users a bug template.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2fa0a65 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,52 @@ +# Babel Contribution Guidelines + +Welcome to Babel! These guidelines will give you a short overview over how we +handle issues and PRs in this repository. Note that they are preliminary and +still need proper phrasing - if you'd like to help - be sure to make a PR. + +Please know that we do appreciate all contributions - bug reports as well as +Pull Requests. + +## Filing Issues + +When filing an issue, please use this template: + +``` +# Overview Description + +# Steps to Reproduce + +1. +2. +3. + +# Actual Results + +# Expected Results + +# Reproducibility + +# Additional Information: + +``` + +## PR Merge Criteria + +For a PR to be merged, the following statements must hold true: + +- All CI services pass. (Windows build, linux build, sufficient test coverage.) +- All commits must have been reviewed and approved by a babel maintainer who is + not the author of the PR. Commits shall comply to the "Good Commits" standards + outlined below. + +## Correcting PRs + +Rebasing PRs is preferred over merging master into the source branches again +and again cluttering our history. If a reviewer has suggestions, the commit +shall be amended so the history is not cluttered by "fixup commits". + +## Writing Good Commits + +Please see +http://coala.readthedocs.org/en/latest/Getting_Involved/Writing_Good_Commits/ +for guidelines on how to write good commits and proper commit messages. |