diff options
Diffstat (limited to 'docs/contributing.rst')
| -rw-r--r-- | docs/contributing.rst | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index 76e7450c..00000000 --- a/docs/contributing.rst +++ /dev/null @@ -1,48 +0,0 @@ -Contributing -============ - -Thank you for your interest in contributing to Soledad! - -Filing bug reports ------------------- - -Bug reports are very welcome. Please file them on the `0xacab issue tracker -<https://0xacab.org/leap/soledad/issues>`_. Please include an extensive -description of the error, the steps to reproduce it, the version of Soledad -used and the provider used (if applicable). - -Patches -------- - -All patches to Soledad should be submitted in the form of pull requests to the -`main Soledad repository <https://0xacab.org/leap/soledad>`_. These pull -requests should satisfy the following properties: - -* The pull request should focus on one particular improvement to Soledad. - Create different pull requests for unrelated features or bugfixes. -* Code should follow `PEP 8 <https://www.python.org/dev/peps/pep-0008/>`_, - especially in the "do what code around you does" sense. -* Pull requests that introduce code must test all new behavior they introduce - as well as for previously untested or poorly tested behavior that they touch. -* Pull requests are not allowed to break existing tests. We will consider pull - requests that are breaking the CI as work in progress. -* When introducing new functionality, please remember to write documentation. -* Please sign all of your commits. If you are merging code from other - contributors, you should sign their commits. - -Review -~~~~~~ - -Pull requests must be reviewed before merging. The final responsibility for the -reviewing of merged code lies with the person merging it. Exceptions to this -rule are modifications to documentation, packaging, or tests when the need of -agility of merging without review has little or no impact on the security and -functionality of working code. - -Getting help -~~~~~~~~~~~~ - -If you need help you can reach us through one of the following means: - -* IRC: ``#leap`` at ``irc.freenode.org``. -* Mailing list: `leap-discuss@lists.riseup.net <https://lists.riseup.net/www/info/leap-discuss>`_ |