commit 2804f6be1e859a44598e938dd68e65614e7ac656 Author: juga0 juga@riseup.net Date: Thu Nov 22 14:01:19 2018 +0000
doc: stop editing changelog on every bug/ticket
Instead create a changelog before new releases.
Closes ticket #28572. --- CONTRIBUTING.rst | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index aeeadad..08cef30 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -128,15 +128,14 @@ Any non-trivial change should contain tests. See ./TESTING.rst. When running tests, currently ``flake8`` informs on some PEP8 errors/warnings, but not all.
-Document your changes in ./CHANGELOG.rst following `keep a changelog`_. -Reference the Tor Project Trac ticket (example: ``#12345``) or -Github ticket (example: ``GH#123``). - .. _commits-ref:
Commits ~~~~~~~~~
+Each commit should reference the Tor Project Trac ticket (example: ``#12345``) +and possibly the bugfix version. + Try to make each commit a logically separate changes.::
As a general rule, your messages should start with a single line that’s @@ -253,6 +252,12 @@ Before major releases, ensure that: - A dirauth should be able to understand the documentation, otherwise the documentation should be clarified.
+.. _changelog: + +Create a ./CHANGELOG.rst file. +Each entry should reference the Tor Project Trac ticket (example: ``#12345``) +and possibly the bugfix version. +Until version 1.0.2 we have followed `keep a changelog`_ format.
.. _commit-msg: