django-oidc-provider/docs/sections/contribute.rst

41 lines
1.4 KiB
ReStructuredText
Raw Permalink Normal View History

2016-02-11 20:24:34 +00:00
.. _contribute:
Contribute
##########
2018-04-11 01:04:24 +00:00
We love contributions, so please feel free to fix bugs, improve things, provide documentation. These are the steps:
2016-02-11 20:24:34 +00:00
2018-04-11 01:04:24 +00:00
* Create an issue and explain your feature/bugfix.
* Wait collaborators comments.
* Fork the project and create new branch from `develop`.
2016-02-11 20:24:34 +00:00
* Make your feature addition or bug fix.
2018-04-11 01:04:24 +00:00
* Add tests and documentation if needed.
* Create pull request for the issue to the `develop` branch.
* Wait collaborators reviews.
2016-02-11 20:24:34 +00:00
Running Tests
=============
2018-03-22 19:52:08 +00:00
Use `tox <https://pypi.python.org/pypi/tox>`_ for running tests in each of the environments, also to run coverage and flake8 among::
2016-02-11 20:24:34 +00:00
2016-07-28 20:18:11 +00:00
# Run all tests.
2016-02-11 20:24:34 +00:00
$ tox
2018-03-22 19:52:08 +00:00
# Run with Python 3.5 and Django 2.0.
$ tox -e py35-django20
2016-07-28 20:18:11 +00:00
2018-03-22 19:52:08 +00:00
# Run single test file on specific environment.
$ tox -e py35-django20 tests/cases/test_authorize_endpoint.py
2016-08-17 14:35:01 +00:00
2018-04-08 21:28:38 +00:00
We also use `travis <https://travis-ci.org/juanifioren/django-oidc-provider/>`_ to automatically test every commit to the project.
2016-04-25 20:33:52 +00:00
Improve Documentation
=====================
We use `Sphinx <http://www.sphinx-doc.org/>`_ for generate this documentation. I you want to add or modify something just:
2016-09-06 18:38:52 +00:00
* Install Sphinx (``pip install sphinx``) and the auto-build tool (``pip install sphinx-autobuild``).
2016-04-25 20:33:52 +00:00
* Move inside the docs folder. ``cd docs/``
2016-09-06 18:38:52 +00:00
* Generate and watch docs by running ``sphinx-autobuild . _build/``.
* Open ``http://127.0.0.1:8000`` in a browser.