Skip to content

Commit d6de471

Browse files
committed
Add contribution guidelines to README
1 parent 7f751be commit d6de471

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,17 @@ Mailing-list
5858
Share your feedback and ideas: `subscribe to the mailing-list
5959
<https://mail.python.org/mailman/listinfo/code-quality>`_
6060

61+
Contributing
62+
------------
63+
64+
Patches may be submitted via a `GitHub pull request`_ or via the mailing list
65+
if you prefer. If you are comfortable doing so, please `rebase your changes`_
66+
so they may be applied to master with a fast-forward merge, and each commit is
67+
a coherent unit of work with a well-written log message. If you are not
68+
comfortable with this rebase workflow, the project maintainers will be happy to
69+
rebase your commits for you.
70+
71+
All changes should be include tests and pass flake8_.
6172

6273
.. image:: https://api.travis-ci.org/pyflakes/pyflakes.png
6374
:target: https://travis-ci.org/pyflakes/pyflakes
@@ -67,3 +78,5 @@ Share your feedback and ideas: `subscribe to the mailing-list
6778
.. _flake8: https://pypi.python.org/pypi/flake8
6879
.. _`PEP 8`: http://legacy.python.org/dev/peps/pep-0008/
6980
.. _Pychecker: http://pychecker.sourceforge.net/
81+
.. _`rebase your changes`: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
82+
.. _`GitHub pull request`: https://github.com/pyflakes/pyflakes/pulls

0 commit comments

Comments
 (0)