So you want to contribute to django-browserid? Great! We really appreciate any help you can give!
The documentation below should help you set up a development environment and run the tests to ensure that your changes work properly.
Get the code¶
You can check out the code from the github repository:
git clone git://github.com/mozilla/django-browserid.git cd django-browserid
mkvirtualenv django-browserid pip install -r requirements.txt
To check if your changes break any existing functionality, you can run the test suite:
Before submitting a pull request, you should run the test suite in all the Django/Python combinations that we support. We support running the tests in all these combinations via tox:
pip install tox tox
If you make changes to the documentation, you can build it locally with this command:
make -C docs/ html
The generated files can be found in