Add contributing guidelines.

jaredhanson · Sep 20, 2017 · 7c7b6e5 · 7c7b6e5
1 parent 6a0f2ce
commit 7c7b6e5
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1,3 +1,4 @@
+CONTRIBUTING.md
 Makefile
 docs/
 examples/

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+## Contributing
+
+### Tests
+
+The test suite is located in the `test/` directory.  All new features are
+expected to have corresponding test cases with complete code coverage.  Patches
+that increse test coverage are happily accepted.
+
+Ensure that the test suite passes by executing:
+
+```bash
+$ make test
+```
+
+Coverage reports can be viewed by executing:
+
+```bash
+$ make test-cov
+$ make view-cov
+```