35 lines
1.3 KiB
ReStructuredText
35 lines
1.3 KiB
ReStructuredText
.. _contribute:
|
|
|
|
Contribute
|
|
##########
|
|
|
|
We love contributions, so please feel free to fix bugs, improve things, provide documentation. You SHOULD follow this steps:
|
|
|
|
* Fork the project.
|
|
* Make your feature addition or bug fix.
|
|
* Add tests for it inside ``oidc_provider/tests``. Then run all and ensure everything is OK (read docs for how to test in all envs).
|
|
* Send pull request to the specific version branch.
|
|
|
|
Running Tests
|
|
=============
|
|
|
|
Use `tox <https://pypi.python.org/pypi/tox>`_ for running tests in each of the environments, also to run coverage among::
|
|
|
|
$ tox
|
|
|
|
If you have a Django project properly configured with the package. Then just run tests as normal::
|
|
|
|
$ python manage.py test --settings oidc_provider.tests.app.settings oidc_provider
|
|
|
|
Also tests run on every commit to the project, we use `travis <https://travis-ci.org/juanifioren/django-oidc-provider/>`_ for this.
|
|
|
|
Improve Documentation
|
|
=====================
|
|
|
|
We use `Sphinx <http://www.sphinx-doc.org/>`_ for generate this documentation. I you want to add or modify something just:
|
|
|
|
* Install Sphinx ``pip install sphinx`` and this theme ``pip install sphinx-rtd-theme``.
|
|
* Move inside the docs folder. ``cd docs/``
|
|
* Generate the HTML. ``make html``
|
|
* Open ``docs/_build/html/index.html`` on a browser.
|