git.iko.soy/searx
on 2fded29 help sign in
searx/docs/dev/contribution_guide.rst
98 lines 3.0 kB history raw
1How to contribute
2-----------------
4Prime directives: Privacy, Hackability
5~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7Searx has two prime directives, privacy-by-design and hackability. The
8hackability comes in three levels:
10- support of search engines
11- plugins to alter search behaviour
12- hacking searx itself
14Note the lack of "world domination" among the directives.
15Searx has no intention of wide mass-adoption, rounded
16corners, etc. The prime directive "privacy" deserves a separate
17chapter, as it's quite uncommon unfortunately.
19Privacy-by-design
20^^^^^^^^^^^^^^^^^
22Searx was born out of the need for a privacy-respecting search tool
23which can be extended easily to maximize both its search and its
24privacy protecting capabilities.
26A few widely used features work differently or turned off by default or not implemented
27at all as a consequence of privacy-by-design.
29If a feature reduces the privacy preserving aspects of searx, it
30should be switched off by default or should not implemented at all.
31There are plenty of search engines already providing such features.
32If a feature reduces the protection of searx, users must be
33informed about the effect of choosing to enable it. Features
34that protect privacy but differ from the expectations of the
35user should also be explained.
37Also, if you think that something works weird with searx,
38it's might be because of the tool you use is designed in a way to interfere with
39the privacy respect. Submitting a bugreport to the vendor of the tool that
40misbehaves might be a good feedback to reconsider the disrespect to
41its customers (e.g. GET vs POST requests in various browsers).
43Remember the other prime directive of searx is to be hackable, so if the
44above privacy concerns do not fancy you, simply fork it.
46Happy hacking.
48Code
49~~~~
51In order to submit a patch, please follow the steps below:
53- Follow coding conventions.
55 - PEP8 standards apply, except the convention of line length
57 - Maximum line length is 120 characters
59- Check if your code breaks existing tests. If so, update the tests or fix your code.
61- If your code can be unit-tested, add unit tests.
63- Add yourself to the AUTHORS file.
65- Create a pull request.
67For more help on getting started with searx development, see :ref:`devquickstart`.
70Translation
71~~~~~~~~~~~
73Translation currently takes place on
74`transifex <https://transifex.com/projects/p/searx>`__.
76**Please, do not update translation files in the repo.**
78Documentation
79~~~~~~~~~~~~~
81The documentation is built using Sphinx. So in order to be able to generate the required
82files, you have to install it on your system. (It can be installed easily using pip.)
841. Checkout the gh-pages branch.
862. Edit the rst file you wish to update. Or create a new rst file and place it under the appropriate folder.
883. Build the documentation using Sphinx.
904. Add the updated and created files of these extension:
92 - .rst
94 - .html
96 - .txt
986. Create a pull request.