Commit 2804f6be authored by juga  's avatar juga
Browse files

doc: stop editing changelog on every bug/ticket

Instead create a changelog before new releases.

Closes ticket #28572.
parent 9f537092
......@@ -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:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment