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-24 16:21:48 +0200 |
commit | 3635d502688725cf9e3227e91c4d29bc84547dd1 (patch) | |
tree | a53beb5c2bc08b330aa90ab82c632cc294570d64 | |
parent | e0cd108ddc56fbc95f28a3d76e55df21ddee34f7 (diff) | |
download | babel-sils/contributing_rst.tar.gz |
Add CONTRIBUTINGsils/contributing_rst
This finally fixes our review process and gives users a bug template.
This file is written using RST syntax so it can be included in the
official documentation.
-rw-r--r-- | CONTRIBUTING | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..daf97c9 --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,55 @@ +***************************** +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. |