From 3f23040fca700b9e15c528ebdebd67764e7cec2c Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 8 Jan 2014 09:21:57 -0800 Subject: Fixed #428 -- added a changelog --- docs/changelog.rst | 9 +++++++++ docs/contributing.rst | 2 ++ docs/doing-a-release.rst | 1 + docs/index.rst | 1 + 4 files changed, 13 insertions(+) create mode 100644 docs/changelog.rst diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 00000000..e46d8c9b --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,9 @@ +Changelog +========= + +0.1 +~~~ + +**Released on XXX** + +* Initial released. diff --git a/docs/contributing.rst b/docs/contributing.rst index 657c4359..8e32c368 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -29,6 +29,8 @@ devastating, ``cryptography`` has a strict code review policy: backwards incompatible release of a dependency) no pull requests may be merged until this is rectified. * All merged patches must have 100% test coverage. +* New features and significant bug fixes should be documented in the + :doc:`/changelog`. The purpose of these policies is to minimize the chances we merge a change which jeopardizes our users' security. diff --git a/docs/doing-a-release.rst b/docs/doing-a-release.rst index 0f382064..194e82f4 100644 --- a/docs/doing-a-release.rst +++ b/docs/doing-a-release.rst @@ -10,6 +10,7 @@ The first step in doing a release is bumping the version number in the software. * Update the version number in ``cryptography/__about__.py``. +* Set the release date in the :doc:`/changelog`. * Do a commit indicating this. * Send a pull request with this. * Wait for it to be merged. diff --git a/docs/index.rst b/docs/index.rst index 4bbfe7fd..9967075a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -80,4 +80,5 @@ The ``cryptography`` open source project security api-stability doing-a-release + changelog community -- cgit v1.2.3 From 7c6d7d6b71743457fe7d7c7f5cd607ca46b187f8 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 8 Jan 2014 09:46:27 -0800 Subject: Typo fix --- docs/changelog.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index e46d8c9b..52fcbfe3 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -6,4 +6,4 @@ Changelog **Released on XXX** -* Initial released. +* Initial release. -- cgit v1.2.3 From 924599e267250bb5f1bb80d6b0345918e3d52094 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 8 Jan 2014 09:47:05 -0800 Subject: Reformat --- docs/changelog.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 52fcbfe3..4d782216 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,9 +1,7 @@ Changelog ========= -0.1 -~~~ - -**Released on XXX** +0.1 - YYYY-MM-DD +~~~~~~~~~~~~~~~~ * Initial release. -- cgit v1.2.3