38 lines
1.3 KiB
ReStructuredText
38 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 tests and ensure everything is OK (see the section below on 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 and flake8 among::
|
|
|
|
# Run all tests.
|
|
$ tox
|
|
|
|
# Run with Python 3.5 and Django 2.0.
|
|
$ tox -e py35-django20
|
|
|
|
# Run single test file on specific environment.
|
|
$ tox -e py35-django20 tests/cases/test_authorize_endpoint.py
|
|
|
|
We also use `travis <https://travis-ci.org/juanifioren/django-oidc-provider/>`_ to automatically test every commit to the project,
|
|
|
|
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 the auto-build tool (``pip install sphinx-autobuild``).
|
|
* Move inside the docs folder. ``cd docs/``
|
|
* Generate and watch docs by running ``sphinx-autobuild . _build/``.
|
|
* Open ``http://127.0.0.1:8000`` in a browser.
|