Skip to content

Commit

Permalink
chore: Update Contributing.md with testing
Browse files Browse the repository at this point in the history
  • Loading branch information
phanak-sap authored Mar 15, 2022
1 parent 5d3f223 commit 54071b0
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,18 @@

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

* Please use following (testing) workflow for your local work (same run on CI Github Actions but should pass locally before creating new PR):

* use virtualenv, so you are isolated from your system-level installed packages
* activate the virtualenv according your OS
* pip install -r dev-requirements.txt
* pip install -r requirements.txt
* pytest --cov-report term --cov=pyodata
* pylint --rcfile=.pylintrc --output-format=parseable --reports=no pyodata
* flake8 --config=.flake8 pyodata

There is a Makefile with all targets that can be used as well, if you are fan of makefiles.

## **Did you fix whitespace, format code, or make a purely cosmetic patch?**

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

0 comments on commit 54071b0

Please sign in to comment.