nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-09-20 13:06:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: Update our requirements for changes file

Browse Source 
Closes tpo/core/team#3.

Signed-off-by: David Goulet <dgoulet@torproject.org>
This commit is contained in:
David Goulet 2020-07-16 13:34:52 -04:00
parent 4b24b36289
commit ca1003b791
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/HACKING/CodingStandards.md
View File

@ -87,6 +87,18 @@ months and expect it to merge cleanly. Try to merge pieces early and often.
## How we log changes
Before diving in the details on how to write a changes file, note that we do
NOT require a changes file for:
* Any change to a file that is not distributed in the tarball. This
includes:
- Any change to our CI configuration that does not affect the distributed
source.
- Any change to developer-only tools, unless those tools are distributed
in the tarball.
* Non-functional code movement.
* Identifier re-namings, comment edits, spelling fixes, and so on.
When you do a commit that needs a ChangeLog entry, add a new file to
the `changes` toplevel subdirectory. It should have the format of a
one-entry changelog section from the current ChangeLog file, as in