diff options
author | Alex Grönholm <alex.gronholm@nextday.fi> | 2017-10-21 14:35:03 +0300 |
---|---|---|
committer | Alex Grönholm <alex.gronholm@nextday.fi> | 2017-10-21 15:08:49 +0300 |
commit | 7263f9d4fd595478c918981b3deb391df6b191eb (patch) | |
tree | 720d82d028d9570a89ca19ecefb722b0ddb62f2f /docs/contributing.rst | |
parent | 6e2e380854901cca22d69dea258299d9d1d897b0 (diff) | |
download | apscheduler-7263f9d4fd595478c918981b3deb391df6b191eb.tar.gz |
Updated the docs to conform to the 99 column limit
Diffstat (limited to 'docs/contributing.rst')
-rw-r--r-- | docs/contributing.rst | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst index 7b63c2c..fdb0660 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -2,8 +2,8 @@ Contributing to APScheduler ########################### -If you wish to add a feature or fix a bug in APScheduler, you need to follow certain procedures and rules to get your -changes accepted. This is to maintain the high quality of the code base. +If you wish to add a feature or fix a bug in APScheduler, you need to follow certain procedures and +rules to get your changes accepted. This is to maintain the high quality of the code base. Contribution Process @@ -18,9 +18,9 @@ Contribution Process 7. Push the changes to your Github fork 8. Make a pull request on Github -There is no need to update the change log -- this will be done prior to the next release at the latest. -Should the test suite fail even before your changes (which should be rare), make sure you're at least not adding to the -failures. +There is no need to update the change log -- this will be done prior to the next release at the +latest. Should the test suite fail even before your changes (which should be rare), make sure +you're at least not adding to the failures. Development Dependencies @@ -32,33 +32,33 @@ To fully run the test suite, you will need at least: * A Redis server * A Zookeeper server -For other dependencies, it's best to look in tox.ini and install what is appropriate for the Python version you're -using. +For other dependencies, it's best to look in tox.ini and install what is appropriate for the Python +version you're using. Code Style ========== -This project uses PEP 8 rules with a maximum column limit of 120 characters instead of the standard 79. +This project uses PEP 8 rules with its maximum allowed column limit of 99 characters. This limit applies to all text files (source code, tests, documentation). -In particular, remember to group the imports correctly (standard library imports first, third party libs second, -project libraries third, conditional imports last). The PEP 8 checker does not check for this. -If in doubt, just follow the surrounding code style as closely as possible. +In particular, remember to group the imports correctly (standard library imports first, third party +libs second, project libraries third, conditional imports last). The PEP 8 checker does not check +for this. If in doubt, just follow the surrounding code style as closely as possible. Testing ======= -Running the test suite is done using the tox utility. This will test the code base against all supported Python -versions and checks for PEP 8 violations as well. +Running the test suite is done using the tox utility. This will test the code base against all +supported Python versions and checks for PEP 8 violations as well. -Since running the tests on every supported Python version can take quite a long time, it is recommended that during the -development cycle py.test is used directly. Before finishing, tox should however be used to make sure the code works on -all supported Python versions. +Since running the tests on every supported Python version can take quite a long time, it is +recommended that during the development cycle py.test is used directly. Before finishing, tox +should however be used to make sure the code works on all supported Python versions. Any nontrivial code changes must be accompanied with the appropriate tests. -The tests should not only maintain the coverage, but should test any new functionality or bug fixes reasonably well. -If you're fixing a bug, first make sure you have a test which fails against the unpatched codebase and succeeds against -the fixed version. Naturally, the test suite has to pass on every Python version. If setting up all the required Python -interpreters seems like too much trouble, make sure that it at least passes on the lowest supported versions of both -Python 2 and 3. +The tests should not only maintain the coverage, but should test any new functionality or bug fixes +reasonably well. If you're fixing a bug, first make sure you have a test which fails against the +unpatched codebase and succeeds against the fixed version. Naturally, the test suite has to pass on +every Python version. If setting up all the required Python interpreters seems like too much +trouble, make sure that it at least passes on the lowest supported versions of both Python 2 and 3. |