| Contributing |
| ============ |
| |
| If you're submitting patches to pagure, please observe the following: |
| |
| - Check that your python code is `PEP8-compliant |
| <http://www.python.org/dev/peps/pep-0008/>`_. There is a `flake8 tool |
| <http://pypi.python.org/pypi/flake8>`_ that automatically checks the sources as |
| part of the tests. |
| |
| - We run the source code through `black <https://pypi.python.org/pypi/black>`_ |
| as part of the tests, so you may have to do some adjustments or run it |
| yourself (which is simple: ``black /path/to/pagure``). |
| |
| - Check that your code doesn't break the test suite. The test suite can be |
| run using the ``runtests.py`` script at the top of the sources, you may |
| use ``python runtests.py run`` to run the tests and ``python runtests.py --help`` |
| to check other options supported. |
| See :doc:`development` for more information about the test suite. |
| |
| - If you are adding new code, please write tests for them in ``tests/``, |
| the ``runtests.py`` script will help you to see the coverage of your code |
| in unit-tests. |
| |
| - If your change warrants a modification to the docs in ``doc/`` or any |
| docstrings in ``pagure/`` please make that modification. |
| |
| .. note:: You have a doubt, you don't know how to do something, you have an |
| idea but don't know how to implement it, you just have something bugging |
| you? |
| |
| Come to see us on IRC: `` |
| irc.freenode.net or directly on `the project <http:`_. |