Skip to content

Commit 50a90a9

Browse files
committed
ci(coverage): updating CONTRIBUTING to reflect CI constraints (#239)
1 parent 9291bce commit 50a90a9

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,15 @@ developing features or fixing bugs yourself.
1919
* If you are interested in contributing code, fork the repository, create a
2020
branch, and open a pull request.
2121

22+
## Code quality and testing
23+
24+
In order to maintain a certain standard regarding code quality, this repository CI will run various tools against expectations:
25+
- `isort` will be used to check for proper imports sorting, and the CI will fail if the checks fail
26+
- `black` will be used to check for proper code formatting, and the CI will fail if the checks fail
27+
- `flake8` will be used to check for proper code styling, and the CI will fail if the checks fail
28+
- `pytest` will be used to run various levels of testing, and the CI will fail if the tests fail
29+
- `coverage` with `codecov` will be used to check for proper code coverage, and the CI will fail if the level is below 80% for the current diff (a warning will be emitted if the level falls below 80% for the overall project)
30+
2231
<!-- filigran-conventions:start -->
2332
## Commit, pull request & issue conventions
2433

0 commit comments

Comments
 (0)