diff options
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c110b23..a79e927 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,7 @@ -Hacking Guidelines: -- write unit tests -- use py.test to run tests -- support python 2.6 and 2.7 -- not 3.x just yet -- pass flake8 checks -- keep that pylint score up! +# How to contribute + +Pull Requests are greatly welcome from everyone! Please make sure to fulfill the following criteria when proposing changes to Warlock: + +- Write unit tests, and run them through pytest; test coverage must not decrease +- Make sure to support Python 2.7 -- 3.7; Travis CI will check all non-EOL version of Python +- Run flake8 without warnings; including flake8-bugbear plugin |