Blame doc/contributing.rst

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