contributing.rst 1.1 KB

123456789101112131415161718192021222324252627
  1. Contributing
  2. ============
  3. If you're submitting patches to pagure, please observe the following:
  4. - Check that your python code is `PEP8-compliant
  5. <http://www.python.org/dev/peps/pep-0008/>`_. There is a `pep8 tool
  6. <http://pypi.python.org/pypi/pep8>`_ that can automatically check
  7. your source.
  8. - Check that your code doesn't break the test suite. The test suite can be
  9. run using the ``runtests.sh`` shell script at the top of the sources.
  10. See :doc:`development` for more information about the test suite.
  11. - If you are adding new code, please write tests for them in ``tests/``,
  12. the ``runtests.sh`` script will help you to see the coverage of your code
  13. in unit-tests.
  14. - If your change warrants a modification to the docs in ``doc/`` or any
  15. docstrings in ``pagure/`` please make that modification.
  16. .. note:: You have a doubt, you don't know how to do something, you have an
  17. idea but don't know how to implement it, you just have something bugging
  18. you?
  19. Come to see us on IRC: ``#fedora-apps`` on irc.freenode.net or directly on
  20. `the project <http://pagure.io>`_.