Permalink
Browse files

Messing with the "contributing" doc.

  • Loading branch information...
1 parent 9eb5496 commit 2e8d59ac24cd2150220a147cff036bf59f18a046 @ralphbean committed Sep 26, 2012
Showing with 39 additions and 2 deletions.
  1. +0 −1 CONTRIBUTING.rst
  2. +25 −0 CONTRIBUTING.rst
  3. +14 −1 doc/contributing.rst
View
View
@@ -0,0 +1,25 @@
+Contributing
+============
+
+If you're submitting patches to fedmsg, please observe the following:
+
+ - Check that your python code is `PEP8-compliant
+ <http://www.python.org/dev/peps/pep-0008/>`_. There is a `pep8 tool
+ <http://pypi.python.org/pypi/pep8>`_ that can automatically check
+ your source. Bind it to a key in vim?
+ - Check that your code doesn't break the test suite. Instructions for running
+ the test suite can be found in :doc:`development`.
+ - If you are adding new code, please write tests for them in ``fedmsg/tests``.
+ - If your change warrants a modification to the docs in ``doc/`` or any
+ docstrings in ``fedmsg/`` please make that modification.
+
+I didn't sign up for this!
+--------------------------
+
+::
+
+ ...all I wanted to do was submit a patch!
+
+
+Don't worry. If you have a contribution but the above guidelines are too
+much to handle, just stop by ``#fedora-apps`` on freenode and let us know.
View
@@ -4,9 +4,22 @@ Contributing
If you're submitting patches to fedmsg, please observe the following:
- Check that your python code is `PEP8-compliant
- <http://www.python.org/dev/peps/pep-0008/>`_.
+ <http://www.python.org/dev/peps/pep-0008/>`_. There is a `pep8 tool
+ <http://pypi.python.org/pypi/pep8>`_ that can automatically check
+ your source. Bind it to a key in vim?
- Check that your code doesn't break the test suite. Instructions for running
the test suite can be found in :doc:`development`.
- If you are adding new code, please write tests for them in ``fedmsg/tests``.
- If your change warrants a modification to the docs in ``doc/`` or any
docstrings in ``fedmsg/`` please make that modification.
+
+I didn't sign up for this!
+--------------------------
+
+::
+
+ ...all I wanted to do was submit a patch!
+
+
+Don't worry. If you have a contribution but the above guidelines are too
+much to handle, just stop by ``#fedora-apps`` on freenode and let us know.

0 comments on commit 2e8d59a

Please sign in to comment.