mirror of https://github.com/searx/searx
152 lines
6.7 KiB
HTML
152 lines
6.7 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>How to contribute — searx 0.8.0 documentation</title>
|
|
|
|
<link rel="stylesheet" href="../_static/style.css" type="text/css" />
|
|
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '../',
|
|
VERSION: '0.8.0',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
<link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
|
|
<link rel="next" title="Installation" href="install/installation.html" />
|
|
<link rel="prev" title="Development Quickstart" href="quickstart.html" />
|
|
|
|
|
|
<link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
|
|
|
|
</head>
|
|
<body role="document">
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body" role="main">
|
|
|
|
<div class="section" id="how-to-contribute">
|
|
<h1>How to contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="prime-directives-privacy-hackability">
|
|
<h2>Prime directives: Privacy, Hackability<a class="headerlink" href="#prime-directives-privacy-hackability" title="Permalink to this headline">¶</a></h2>
|
|
<p>Searx has two prime directives, privacy-by-design and hackability. The
|
|
hackability comes in three levels:</p>
|
|
<ul class="simple">
|
|
<li>support of search engines</li>
|
|
<li>plugins to alter search behaviour</li>
|
|
<li>hacking searx itself</li>
|
|
</ul>
|
|
<p>Note the lack of “world domination” among the directives.
|
|
Searx has no intention of wide mass-adoption, rounded
|
|
corners, etc. The prime directive “privacy” deserves a separate
|
|
chapter, as it’s quite uncommon unfortunately.</p>
|
|
<div class="section" id="privacy-by-design">
|
|
<h3>Privacy-by-design<a class="headerlink" href="#privacy-by-design" title="Permalink to this headline">¶</a></h3>
|
|
<p>Searx was born out of the need for a privacy-respecting search tool
|
|
which can be extended easily to maximize both its search and its
|
|
privacy protecting capabilities.</p>
|
|
<p>A few widely used features work differently or turned off by default or not implemented
|
|
at all as a consequence of privacy-by-design.</p>
|
|
<p>If a feature reduces the privacy preserving aspects of searx, it
|
|
should be switched off by default or should not implemented at all.
|
|
There are plenty of search engines already providing such features.
|
|
If a feature reduces the protection of searx, users must be
|
|
informed about the effect of choosing to enable it. Features
|
|
that protect privacy but differ from the expectations of the
|
|
user should also be explained.</p>
|
|
<p>Also, if you think that something works weird with searx,
|
|
it’s might be because of the tool you use is designed in a way to interfere with
|
|
the privacy respect. Submitting a bugreport to the vendor of the tool that
|
|
misbehaves might be a good feedback to reconsider the disrespect to
|
|
its customers (e.g. GET vs POST requests in various browsers).</p>
|
|
<p>Remember the other prime directive of searx is to be hackable, so if the
|
|
above privacy concerns do not fancy you, simply fork it.</p>
|
|
<p>Happy hacking.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="code">
|
|
<h2>Code<a class="headerlink" href="#code" title="Permalink to this headline">¶</a></h2>
|
|
<p>In order to submit a patch, please follow the steps below:</p>
|
|
<ul class="simple">
|
|
<li>Follow coding conventions.<ul>
|
|
<li>PEP8 standards apply, except the convention of line length</li>
|
|
<li>Maximum line length is 120 characters</li>
|
|
</ul>
|
|
</li>
|
|
<li>Check if your code breaks existing tests. If so, update the tests or fix your code.</li>
|
|
<li>If your code can be unit-tested, add unit tests.</li>
|
|
<li>Add yourself to the AUTHORS file.</li>
|
|
<li>Create a pull request.</li>
|
|
</ul>
|
|
<p>For more help on getting started with searx development, see <a class="reference internal" href="quickstart.html#devquickstart"><span class="std std-ref">Development Quickstart</span></a>.</p>
|
|
</div>
|
|
<div class="section" id="translation">
|
|
<h2>Translation<a class="headerlink" href="#translation" title="Permalink to this headline">¶</a></h2>
|
|
<p>Translation currently takes place on
|
|
<a class="reference external" href="https://transifex.com/projects/p/searx">transifex</a>.</p>
|
|
<p><strong>Please, do not update translation files in the repo.</strong></p>
|
|
</div>
|
|
<div class="section" id="documentation">
|
|
<h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2>
|
|
<p>The documentation is built using Sphinx. So in order to be able to generate the required
|
|
files, you have to install it on your system. (It can be installed easily using pip.)</p>
|
|
<ol class="arabic simple">
|
|
<li>Checkout the gh-pages branch.</li>
|
|
<li>Edit the rst file you wish to update. Or create a new rst file and place it under the appropriate folder.</li>
|
|
<li>Build the documentation using Sphinx.</li>
|
|
<li>Add the updated and created files of these extension:<ul>
|
|
<li>.rst</li>
|
|
<li>.html</li>
|
|
<li>.txt</li>
|
|
</ul>
|
|
</li>
|
|
</ol>
|
|
<ol class="arabic simple" start="6">
|
|
<li>Create a pull request.</li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
|
<div class="sphinxsidebarwrapper"><div class="sidebar_container body">
|
|
<h1>Searx</h1>
|
|
<ul>
|
|
<li><a href="../index.html">Home</a></li>
|
|
<li><a href="https://github.com/asciimoo/searx">Source</a></li>
|
|
<li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
|
|
<li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
|
|
</ul>
|
|
<hr />
|
|
<ul>
|
|
<li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
|
|
<li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
|
|
<li><a href="https://gratipay.com/searx">Gratipay</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2015, Adam Tauber.
|
|
</div>
|
|
</body>
|
|
</html> |