aboutsummaryrefslogtreecommitdiffstats
path: root/docs/contributing.rst
blob: 061d9a378a1dc8e6e63c8ef3fb54537e87cc1411 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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.