Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ealcobaca committed Aug 8, 2019
1 parent 99bad37 commit 2e4a6be
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ tools:
$ pip install pytest pytest-cov
$ pytest tests/ --showlocals -v --cov=pymfe/

- For Avoid source-code bug and keep quality, check with:
- For avoiding source-code bug and keep quality, check with:

$ pip install pylint
$ pylint path/to/module.py -d 'C0103, R0913, R0902, R0914, C0302, R0904, R0801, E1101'
Expand All @@ -94,7 +94,24 @@ tools:

$ pip install mypy
$ mypy path/to/module.py --ignore-missing-imports
We added a Makefile to execute all this command in a simple way:

- For installing all necessary libraries:

$ make install-dev

- For checking typing, source code style and code quality:

$ make code-check

- For executing all the tests:

$ make test-cov

- For executing all the tests:

$ make all

Report bugs
-----------
Expand Down

0 comments on commit 2e4a6be

Please sign in to comment.