forked from zaclys/searxng
add dev tips to quickstart
This commit is contained in:
parent
20b1f1ba8b
commit
9c56154cfe
|
@ -64,6 +64,8 @@ In order to submit a patch, please follow the steps below:
|
||||||
|
|
||||||
- Create a pull request.
|
- Create a pull request.
|
||||||
|
|
||||||
|
For more help on getting started with searx development, see :ref:`devquickstart`.
|
||||||
|
|
||||||
|
|
||||||
Translation
|
Translation
|
||||||
~~~~~~~~~~~
|
~~~~~~~~~~~
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _devquickstart:
|
||||||
|
|
||||||
Development Quickstart
|
Development Quickstart
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
|
@ -88,3 +90,19 @@ After installing grunt, the files can be built using the following command:
|
||||||
.. code:: sh
|
.. code:: sh
|
||||||
|
|
||||||
./manage.sh build_grunt
|
./manage.sh build_grunt
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Tips for debugging/development
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
1. Turn on debug logging
|
||||||
|
Whether you are working on a new engine or trying to eliminate a bug, it is always a good idea
|
||||||
|
to turn on debug logging. When debug logging is enabled a stack trace appears,
|
||||||
|
instead of the cryptic ``Internal Server Error`` message. It can be turned on by setting
|
||||||
|
``debug: False`` to ``debug: True`` in settings.yml.
|
||||||
|
|
||||||
|
2. Run ``./manage.sh tests`` before creating a PR.
|
||||||
|
Failing build on Travis is common because of PEP8 checks. So a new commit must be created
|
||||||
|
containing these format fixes. This phase can be skipped if ``./manage.sh tests`` is run
|
||||||
|
locally before creating a PR.
|
||||||
|
|
Loading…
Reference in New Issue