diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2c44f67..09a91d5 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,8 +5,8 @@ This project accepts contributions. In order to contribute, you should pay attention to a few things: 1. your code must follow the coding style rules -2. your code must be fully (100% coverage) unit-tested -3. your code must be fully documented +2. your code must be unit-tested +3. your code must be documented 4. your work must be signed 5. the format of the submission must be email patches or GitHub Pull Requests @@ -14,12 +14,11 @@ pay attention to a few things: Coding and documentation Style: ------------------------------- -- The coding style follows `PEP-8: Style Guide for Python Code `_ +- The coding style follows `PEP-8: Style Guide for Python Code `_ (~100 chars/lines is a good limit) - The documentation style follows `PEP-257: Docstring Conventions `_ -A good practice is to frequently run you code through `pylint -`_ -and make sure the code grades ``10.0``. +A good practice is to frequently run you code through `pylint `_ +and make sure the code grades does not decrease. Submitting Modifications: -------------------------