diff options
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..061d9a3 --- /dev/null +++ b/docs/contributing.rst @@ -0,0 +1,53 @@ +Contributing +============ + +Code +---- + +The code is available `on GitHub +<http://github.com/django-debug-toolbar/django-debug-toolbar>`_. + +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 + +.. _virtualenv: http://www.virtualenv.org/ + +Once you've done this, you can run the test suite on all supported version of +Django and Python:: + + $ tox + +Bug reports and feature requests +-------------------------------- + +You can report bugs and request features in the `bug tracker +<http://github.com/django-debug-toolbar/django-debug-toolbar/issues>`_. + +Please search the existing database for duplicates before filing an issue. + +Patches +------- + +Please submit `pull requests +<http://github.com/django-debug-toolbar/django-debug-toolbar/pulls>`_! + +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 +<https://www.transifex.net/projects/p/django-debug-toolbar/>`_. + +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. |