Merge pull request jazzband#503 from vphilippon/improve-contributing-…

…guidelines Add a PR checklist and some precisions on the contributing guidelines.
lyft · May 2, 2017 · cdeb1d8 · cdeb1d8
2 parents 9900cd7 + 1a46ad7
commit cdeb1d8
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,7 @@
+Describe the changes here.
+
+##### Contributor checklist
+
+- [ ] Provided the tests for the changes
+- [ ] Added the changes to CHANGELOG.md
+- [ ] Requested (or received) a review from another contributor
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,3 +3,13 @@
 This is a [Jazzband](https://jazzband.co/) project. By contributing you agree
 to abide by the [Contributor Code of Conduct](https://jazzband.co/about/conduct)
 and follow the [guidelines](https://jazzband.co/about/guidelines).
+
+Also, here are a few additionnal or emphasized guidelines to follow:
+- Always provide tests for your changes.
+- Add your changes to the changelog.
+- Wait for the review of at least one other contributor before merging (even if you're a Jazzband member).
+
+The only exception to those guidelines is for trivial changes, such as
+documentation corrections or contributions that do not change pip-tools itself.
+
+Contributions following these guidelines are always welcomed, encouraged and appreciated.