@@ -1,3 +1,5 @@
1+.. _devquickstart:
2+
13Development Quickstart
24----------------------
35
@@ -88,3 +90,19 @@ After installing grunt, the files can be built using the following command:
8890.. code:: sh
8991
9092 ./manage.sh build_grunt
93+
94+
95+
96+Tips for debugging/development
97+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98+
99+1. Turn on debug logging
100+ Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
101+ to turn on debug logging. When debug logging is enabled a stack trace appears,
102+ instead of the cryptic ``Internal Server Error`` message. It can be turned on by setting
103+ ``debug: False`` to ``debug: True`` in settings.yml.
104+
105+2. Run ``./manage.sh tests`` before creating a PR.
106+ Failing build on Travis is common because of PEP8 checks. So a new commit must be created
107+ containing these format fixes. This phase can be skipped if ``./manage.sh tests`` is run
108+ locally before creating a PR.