diff options
author | Laurens Van Houtven <_@lvh.cc> | 2014-03-15 21:42:31 +0100 |
---|---|---|
committer | Laurens Van Houtven <_@lvh.cc> | 2014-03-15 21:42:31 +0100 |
commit | 5a422984825504381322ade1fa6fbf74078b8831 (patch) | |
tree | 4375bba9597adebc91d3369af01e6b2708b80868 | |
parent | dc06b70d7fd542591bba1600941d318cf3e5050c (diff) | |
download | pyopenssl-git-5a422984825504381322ade1fa6fbf74078b8831.tar.gz |
ReStructured Textify
-rw-r--r-- | CONTRIBUTING.rst (renamed from CONTRIBUTING.md) | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.rst index 34c28ed..16b6b51 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.rst @@ -1,36 +1,39 @@ -# Contributing +Contributing +============ First of all, thank you for your interest in contributing to pyOpenSSL! -## Filing bug reports +Filing bug reports +------------------ Bug reports are very welcome. Please file them on the Github issue tracker. Good bug reports come with extensive descriptions of the error and how to reproduce it. Reporters are strongly encouraged to -include an [SSCCE](http://www.sscce.org/). +include an `SSCCE <http://www.sscce.org/>`_. -## Patches +Patches +------- All patches to pyOpenSSL should be submitted in the form of pull -requests to the main pyOpenSSL repository, `pyca/pyopenssl`. These +requests to the main pyOpenSSL repository, ``pyca/pyopenssl``. These pull requests should satisfy the following properties: - Pull requests that involve code must follow the - [Twisted Coding Standard][tcs]. For example, `methodNamesLikeThis`, + `Twisted Coding Standard`_. For example, ``methodNamesLikeThis``, three empty lines between module-level elements, and two empty lines between class-level elements. - Pull requests that introduce code must test all new behavior they introduce, as well as previously untested or poorly tested behavior that they touch. - Pull requests are not allowed to break existing tests. -- Pull requests that include major changes should note those changes - in the `ChangeLog` text file in the root of the repository. +- Pull requests that introduce features or fix bugs should note those + changes in the ``ChangeLog`` text file in the root of the repository. Finally, pull requests must be reviewed before merging. This process -is based on [the one from cryptography][cryptography-review]. Everyone -can perform reviews; this is a very valuable way to contribute, and is -highly encouraged. +mirrors the `cryptography code review process`_. Everyone can perform +reviews; this is a very valuable way to contribute, and is highly +encouraged. All members of the pyca Github organization can merge pull requests, of course keeping in mind all the requirements detailed in this @@ -41,6 +44,4 @@ the person merging it; since pyOpenSSL is obviously a sensitive project from a security perspective, so reviewers are strongly encouraged to take this review and merge process very seriously. -[tcs]: https://twistedmatrix.com/documents/current/core/development/policy/coding-standard.html -"Twisted Coding Standard" -[cryptography-review]: https://cryptography.io/en/latest/development/reviewing-patches/ +.. _cryptography code review process: https://cryptography.io/en/latest/development/reviewing-patches/ |