diff options
| author | Laurens Van Houtven <_@lvh.cc> | 2014-03-15 21:48:53 +0100 |
|---|---|---|
| committer | Laurens Van Houtven <_@lvh.cc> | 2014-03-15 21:48:53 +0100 |
| commit | df531cc9559a8aea37438fee13359333962279b3 (patch) | |
| tree | 0ae78f67e9e7a9b3edf34bfbe4fbb5d4de257ea3 /CONTRIBUTING.rst | |
| parent | 5a422984825504381322ade1fa6fbf74078b8831 (diff) | |
| download | pyopenssl-df531cc9559a8aea37438fee13359333962279b3.tar.gz | |
Mention changes should be documented
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 16b6b51..c43a1c7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -28,7 +28,9 @@ pull requests should satisfy the following properties: that they touch. - Pull requests are not allowed to break existing tests. - Pull requests that introduce features or fix bugs should note those - changes in the ``ChangeLog`` text file in the root of the repository. + changes in the ``ChangeLog`` text file in the root of the + repository. They should also document the changes, both in + docstrings and in the documentation in the ``doc/`` directory. Finally, pull requests must be reviewed before merging. This process mirrors the `cryptography code review process`_. Everyone can perform |