github/sprockets-postgres
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets-postgres.git synced 2024-11-21 19:28:34 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add CONTRIBUTING info

Browse source
This commit is contained in:
Gavin M. Roy 2020-04-08 18:23:42 -04:00
parent 75b8d49bed
commit fb816ddca7
1 changed files with 23 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
CONTRIBUTING.md Normal file
View file

@ -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.