11Contributing
22============
33
4+ Bug reports and feature requests
5+ --------------------------------
6+
7+ You can report bugs and request features in the `bug tracker
8+ <http://github.com/django-debug-toolbar/django-debug-toolbar/issues> `_.
9+
10+ Please search the existing database for duplicates before filing an issue.
11+
412Code
513----
614
@@ -14,18 +22,31 @@ the libraries required for working on the Debug Toolbar::
1422
1523.. _virtualenv : http://www.virtualenv.org/
1624
17- Once you've done this, you can run the test suite on all supported version of
18- Django and Python::
25+ Tests
26+ -----
27+
28+ Once you've set up a development environment as explained above, you can run
29+ the test suite::
30+
31+ $ make test
32+
33+ You can also run the test suite on all supported versions of Django and
34+ Python::
1935
2036 $ tox
2137
22- Bug reports and feature requests
23- --------------------------------
38+ This is strongly recommended before committing changes to Python code.
2439
25- You can report bugs and request features in the ` bug tracker
26- <http://github.com/django-debug-toolbar/django-debug-toolbar/issues> `_ .
40+ At this time, there isn't an easy way to test against databases other than
41+ SQLite. The JaveScript code isn't tested either .
2742
28- Please search the existing database for duplicates before filing an issue.
43+ Style
44+ -----
45+
46+ Python code for the Django Debug Toolbar follows PEP8. Line length is limited
47+ to 100 characters. You can check for style violations with::
48+
49+ $ make flake8
2950
3051Patches
3152-------
@@ -37,6 +58,10 @@ The Debug Toolbar includes a limited but growing test suite. If you fix a bug
3758or add a feature code, please consider adding proper coverage in the test
3859suite, especially if it has a chance for a regression.
3960
61+ If you change a CSS or a JavaScript file, you should update both the original
62+ file and the minified version in the same commit. Use ``make compress_css ``
63+ and ``make compress_js `` to minify files.
64+
4065Translations
4166------------
4267
@@ -45,6 +70,9 @@ Translation efforts are coordinated on `Transifex
4570
4671Help translate the Debug Toolbar in your language!
4772
73+ Prior to a release, the English ``.po `` file must be updated with ``make
74+ translatable_strings ``. Once translators have updated the translations on
75+ Transifex, all ``.po `` files must be updated with ``make update_translations ``.
4876
4977Mailing list
5078------------
0 commit comments