Contributing

Jazzband

This is a Jazzband project. By contributing you agree to abide by the Contributor Code of Conduct and follow the guidelines.

Bug reports and feature requests

You can report bugs and request features in the bug tracker.

Please search the existing database for duplicates before filing an issue.

Code

The code is available on GitHub.

Once you’ve obtained a checkout, you should create a virtualenv and install the libraries required for working on the Debug Toolbar:

$ pip install -r requirements_dev.txt

You can run now run the example application:

$ DJANGO_SETTINGS_MODULE=example.settings django-admin migrate
$ DJANGO_SETTINGS_MODULE=example.settings django-admin runserver

For convenience, there’s an alias for the second command:

$ make example

Look at example/settings.py for running the example with another database than SQLite.

Tests

Once you’ve set up a development environment as explained above, you can run the test suite for the versions of Django and Python installed in that environment:

$ make test

You can enable coverage measurement during tests:

$ make coverage

You can also run the test suite on all supported versions of Django and Python:

$ tox

This is strongly recommended before committing changes to Python code.

The test suite includes frontend tests written with Selenium. Since they’re annoyingly slow, they’re disabled by default. You can run them as follows:

$ make test_selenium

or by setting the DJANGO_SELENIUM_TESTS environment variable:

$ DJANGO_SELENIUM_TESTS=true make test
$ DJANGO_SELENIUM_TESTS=true make coverage
$ DJANGO_SELENIUM_TESTS=true tox

At this time, there isn’t an easy way to test against databases other than SQLite.

Style

Python code for the Django Debug Toolbar follows PEP8. Line length is limited to 100 characters. You can check for style violations with:

$ make flake8

Import style is enforce by isort. You can sort import automatically with:

$ make isort

Patches

Please submit pull requests!

The Debug Toolbar includes a limited but growing test suite. If you fix a bug or add a feature code, please consider adding proper coverage in the test suite, especially if it has a chance for a regression.

Translations

Translation efforts are coordinated on Transifex.

Help translate the Debug Toolbar in your language!

Mailing list

This project doesn’t have a mailing list at this time. If you wish to discuss a topic, please open an issue on GitHub.

Making a release

Prior to a release, the English .po file must be updated with make translatable_strings and pushed to Transifex. Once translators have done their job, .po files must be downloaded with make update_translations.

The release itself requires the following steps:

  1. Bump version numbers in docs/conf.py, README.rst and setup.py and commit.
  2. Tag the new version.
  3. python setup.py sdist bdist_wheel upload.
  4. Push the commit and the tag.
  5. Change the default version of the docs to point to the latest release: https://readthedocs.org/dashboard/django-debug-toolbar/versions/