From: Lasse Schuirmann <lasse.schuirmann@gmail.com>
Date: Tue, 22 Sep 2015 21:21:20 +0000 (+0200)
Subject: Add CONTRIBUTING
X-Git-Tag: dev-2a51c9b95d06~13^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1174bff582e4a8c41bec10b7114aa202a32c6b48;p=thirdparty%2Fbabel.git

Add CONTRIBUTING

This finally fixes our review process and gives users a bug template.
---

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..2fa0a658
--- /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.