diff options
| author | Aymeric Augustin | 2013-10-27 14:41:22 +0100 | 
|---|---|---|
| committer | Aymeric Augustin | 2013-10-27 14:41:22 +0100 | 
| commit | 6e4b8d95b8bcdeeab039f0a0c7e6d6833cd8685e (patch) | |
| tree | d110f54face6d32b459c4a43fce0ed5c66bcc839 /docs/contributing.rst | |
| parent | 0b05a1b7257079d623012cd06cade1be4a0ff0d4 (diff) | |
| download | django-debug-toolbar-6e4b8d95b8bcdeeab039f0a0c7e6d6833cd8685e.tar.bz2 | |
Migrate info from README to docs.
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 51 | 
1 files changed, 51 insertions, 0 deletions
| diff --git a/docs/contributing.rst b/docs/contributing.rst index 5a1988f..061d9a3 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -1,2 +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. | 
