zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 19:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

Create a pre-commit hook which is copied on installation

Browse source 
Allow propogating specific files to format for black

Update build messages for black

update hook

Update hook further, add related doc
This commit is contained in:
Grant Lanham 2024-08-24 00:25:58 -04:00
parent 4f7dd05d99
commit bce9669d74
4 changed files with 44 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/dev/quickstart.rst
View file

@ -28,6 +28,13 @@ Here is how a minimal workflow looks like:
2. *run* your code: :ref:`make run`
3. *format & test* your code: :ref:`make format.python` and :ref:`make test`
.. tip::
If you run `make install`, and you export the environment variable
`SEARXNG_PRECOMMIT="true"`, a git pre-commit hook will run which will auto format
all python files you check into git for you. If you find this would be
better to enable by default, let us know.
If you think at some point something fails, go back to *start*. Otherwise,
choose a meaningful commit message and we are happy to receive your pull
request. To not end in *wild west* we have some directives, please pay attention