diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2017-01-10 05:37:07 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2017-01-10 05:37:07 -0500 |
| commit | c66f3ef8f899e131fad2b664e86c8880620ab983 (patch) | |
| tree | 7d65659be3bcbf89e97195232208f45429f7988e /doc | |
| parent | 78f7a3e394f1b31b9a2f87759ae09138453e1f30 (diff) | |
| download | python-coveragepy-c66f3ef8f899e131fad2b664e86c8880620ab983.tar.gz | |
A little more about contribution
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/contributing.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/contributing.rst b/doc/contributing.rst index f6155ca..ba1863f 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -149,7 +149,12 @@ The source is pylint-clean, even if it's because there are pragmas quieting some warnings. Please try to keep it that way, but don't let pylint warnings keep you from sending patches. I can clean them up. -Lines should be kept to a 100-character maximum length. +Lines should be kept to a 100-character maximum length. I recommend an +`editorconfig.org`_ plugin for your editor of choice. + +Other style questions are best answered by looking at the existing code. +Formatting of docstrings, comments, long lines, and so on, should match the +code that already exists. Coverage testing coverage.py @@ -170,8 +175,9 @@ Contributing When you are ready to contribute a change, any way you can get it to me is probably fine. A pull request on Bitbucket is great, but a simple diff or -patch is great too. +patch works too. +.. _editorconfig.org: http://editorconfig.org .. _Mercurial: https://www.mercurial-scm.org/ .. _tox: http://tox.testrun.org/ |