Create CONTRIBUTING.md

smbiz1 · Feb 15, 2019 · 03721d6 · 03721d6
1 parent 10f0ea8
commit 03721d6
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# How to contribute
+
+There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on
+top of things.
+
+## Getting Started
+
+* Fork the repository
+* Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or fixing a bug, we need a test!
+* Run the tests. We only take pull requests with passing tests
+
+## Submitting Changes
+
+* Push your changes to your fork.
+* Submit a pull request.
+
+# Additional Resources
+
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)