diff --git a/.npmignore b/.npmignore index a50451d..3e53844 100644 --- a/.npmignore +++ b/.npmignore @@ -1,3 +1,4 @@ +CONTRIBUTING.md Makefile docs/ examples/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4c5ed0d --- /dev/null +++ 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 +```