From df531cc9559a8aea37438fee13359333962279b3 Mon Sep 17 00:00:00 2001 From: Laurens Van Houtven <_@lvh.cc> Date: Sat, 15 Mar 2014 21:48:53 +0100 Subject: Mention changes should be documented --- CONTRIBUTING.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'CONTRIBUTING.rst') 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 -- cgit v1.2.1