Add CONTRIBUTING.md

ianlopshire · Jan 3, 2020 · 1f731cf · 1f731cf
1 parent 14069c2
commit 1f731cf
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,11 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue.
+
+## Pull Request Guidelines
+
+* Ensure your PR is up-to-date with the master branch.
+* Ensure all unit tests and integration tests are passing.
+* Ensure changes are covered by unit tests and integration tests where possible.
+* Ensure changes to the package's public API are covered in the documentation. 
+* Remove superfluous changes to keep the diff as small as possible.