Skip to content

Commit 54071b0

Browse files
authored
chore: Update Contributing.md with testing
1 parent 5d3f223 commit 54071b0

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

CONTRIBUTING.md

+12
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,18 @@
4242

4343
* Update [CHANGELOG.md](CHANGELOG.md) (Unreleased section)
4444

45+
* Please use following (testing) workflow for your local work (same run on CI Github Actions but should pass locally before creating new PR):
46+
47+
* use virtualenv, so you are isolated from your system-level installed packages
48+
* activate the virtualenv according your OS
49+
* pip install -r dev-requirements.txt
50+
* pip install -r requirements.txt
51+
* pytest --cov-report term --cov=pyodata
52+
* pylint --rcfile=.pylintrc --output-format=parseable --reports=no pyodata
53+
* flake8 --config=.flake8 pyodata
54+
55+
There is a Makefile with all targets that can be used as well, if you are fan of makefiles.
56+
4557
## **Did you fix whitespace, format code, or make a purely cosmetic patch?**
4658

4759
Changes that are cosmetic in nature and do not add anything substantial to the

0 commit comments

Comments
 (0)