diff options
| author | David Reid <dreid@dreid.org> | 2014-01-08 11:12:31 -0800 |
|---|---|---|
| committer | David Reid <dreid@dreid.org> | 2014-01-08 11:12:31 -0800 |
| commit | 4177d48e652f95216bf6d630ef035142c1fbe54c (patch) | |
| tree | ae294c040becca7323d94ad490ed8d66b9fa807e /docs | |
| parent | 4fb8dc8af399d8b818c34f5dfd3e9a7b91616842 (diff) | |
| parent | 924599e267250bb5f1bb80d6b0345918e3d52094 (diff) | |
| download | cryptography-4177d48e652f95216bf6d630ef035142c1fbe54c.tar.gz cryptography-4177d48e652f95216bf6d630ef035142c1fbe54c.tar.bz2 cryptography-4177d48e652f95216bf6d630ef035142c1fbe54c.zip | |
Merge pull request #429 from alex/changelog
Fixed #428 -- added a changelog
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/changelog.rst | 7 | ||||
| -rw-r--r-- | docs/contributing.rst | 2 | ||||
| -rw-r--r-- | docs/doing-a-release.rst | 1 | ||||
| -rw-r--r-- | docs/index.rst | 1 |
4 files changed, 11 insertions, 0 deletions
diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 00000000..4d782216 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,7 @@ +Changelog +========= + +0.1 - YYYY-MM-DD +~~~~~~~~~~~~~~~~ + +* Initial release. 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 |