| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133 |
- ============
- Contributing
- ============
- Contributions are welcome, and they are greatly appreciated! Every
- little bit helps, and credit will always be given.
- You can contribute in many ways:
- Types of Contributions
- ----------------------
- Report Bugs
- ~~~~~~~~~~~
- Report bugs at `<https://github.com/mozilla/mozilla-django-oidc/issues>`_.
- If you are reporting a bug, please include:
- * Your operating system name and version.
- * Any details about your local setup that might be helpful in troubleshooting.
- * Detailed steps to reproduce the bug.
- Fix Bugs
- ~~~~~~~~
- Look through the GitHub issues for bugs. Anything tagged with "bug"
- is open to whoever wants to implement it.
- Implement Features
- ~~~~~~~~~~~~~~~~~~
- Look through the GitHub issues for features. Anything tagged with "feature"
- is open to whoever wants to implement it.
- Write Documentation
- ~~~~~~~~~~~~~~~~~~~
- mozilla-django-oidc could always use more documentation, whether as part of the
- official mozilla-django-oidc docs, in docstrings, or even on the web in blog posts,
- articles, and such.
- Submit Feedback
- ~~~~~~~~~~~~~~~
- The best way to send feedback is to file an issue at `<https://github.com/mozilla/mozilla-django-oidc/issues>`_.
- If you are proposing a feature:
- * Explain in detail how it would work.
- * Keep the scope as narrow as possible, to make it easier to implement.
- * Remember that this is a volunteer-driven project, and that contributions
- are welcome :)
- Get Started!
- ------------
- Ready to contribute? Here's how to set up `mozilla-django-oidc` for local development.
- 1. Fork the `mozilla-django-oidc` repo on GitHub.
- 2. Clone your fork locally::
- $ git clone git@github.com:your_name_here/mozilla-django-oidc.git
- 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
- $ mkvirtualenv mozilla-django-oidc
- $ cd mozilla-django-oidc/
- $ python setup.py develop
- 4. Create a branch for local development::
- $ git checkout -b name-of-your-bugfix-or-feature
- Now you can make your changes locally.
- 5. When you're done making changes, check that your changes pass flake8 and the
- tests, including testing other Python versions with tox::
- $ flake8 mozilla_django_oidc tests
- $ python setup.py test
- $ tox
- To get flake8 and tox, just pip install them into your virtualenv.
- 6. Make sure you update ``HISTORY.rst`` with your changes in the following categories
- * Backwards-incompatible changes
- * Features
- * Bugs
- 7. Commit your changes and push your branch to GitHub::
- $ git add .
- $ git commit -m "Your detailed description of your changes."
- $ git push origin name-of-your-bugfix-or-feature
- 8. Submit a pull request through the GitHub website.
- Pull Request Guidelines
- -----------------------
- Before you submit a pull request, check that it meets these guidelines:
- 1. The pull request should include tests.
- 2. If the pull request adds functionality, the docs should be updated. Put
- your new functionality into a function with a docstring, and add the
- feature to the list in README.rst.
- 3. The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check
- `<https://travis-ci.org/mozilla/mozilla-django-oidc/pull_requests>`_
- and make sure that the tests pass for all supported Python versions.
- Tips
- ----
- We use tox to run tests::
- $ tox
- To run a specific environment, use the ``-e`` argument::
- $ tox -e py27-django18
- You can also run the tests in a virtual environment without tox::
- $ DJANGO_SETTINGS_MODULE=tests.settings django-admin.py test
- You can specify test modules to run rather than the whole suite::
- $ DJANGO_SETTINGS_MODULE=tests.settings django-admin.py test tests.test_views
|