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 | f0337bcc49ebd1664ea967bca9044af501a45e7c (patch) | |
| tree | 0dd006a58077103ee9f20b5e17aaefbd14fc6070 | |
| parent | c881bb1370be0ecf5b8a19cfaa6ed17e24d21ca2 (diff) | |
| download | python-coveragepy-git-f0337bcc49ebd1664ea967bca9044af501a45e7c.tar.gz | |
A little more about contribution
| -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 f6155caf..ba1863fb 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/ |