mirror of
https://github.com/sprockets/sprockets-postgres.git
synced 2024-11-14 11:19:27 +00:00
Add CONTRIBUTING info
This commit is contained in:
parent
75b8d49bed
commit
fb816ddca7
1 changed files with 23 additions and 0 deletions
23
CONTRIBUTING.md
Normal file
23
CONTRIBUTING.md
Normal 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.
|
Loading…
Reference in a new issue