blob: 8c8a49be40e56b1a0ba71f9b3ad7f517fcdfd03e (
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
Contributing
============
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.
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/
You can run now run the example application::
$ make example
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.
At this time, there isn't an easy way to test against databases other than
SQLite. The JaveScript code isn't tested either.
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
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.
If you change a CSS or a JavaScript file, you should update both the original
file and the minified version in the same commit. Use ``make compress_css``
and ``make compress_js`` to minify files.
Translations
------------
Translation efforts are coordinated on `Transifex
<https://www.transifex.net/projects/p/django-debug-toolbar/>`_.
Help translate the Debug Toolbar in your language!
Prior to a release, the English ``.po`` file must be updated with ``make
translatable_strings``. Once translators have updated the translations on
Transifex, all ``.po`` files must be updated with ``make update_translations``.
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.
|
