From fb816ddca78c8e5b8a40ff7c5767c63388317559 Mon Sep 17 00:00:00 2001 From: "Gavin M. Roy" Date: Wed, 8 Apr 2020 18:23:42 -0400 Subject: [PATCH] Add CONTRIBUTING info --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c74dfbc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# Contributing + +To get setup in the environment and run the tests, take the following steps: + +```bash +python3 -m venv env +source env/bin/activate +pip install -e '.[testing]' + +bootstrap + +flake8 +coverage run && coverage report +``` + +## Test Coverage + +Pull requests that make changes or additions that are not covered by tests +will likely be closed without review. + +In addition, all tests must pass the tests **AND** flake8 linter. If flake8 +exceptions are included, the reasoning for adding the exception must be included +in the pull request.