aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2020-07-16 14:53:03 -0400
committerNick Mathewson <nickm@torproject.org>2020-07-16 14:53:03 -0400
commit85219d887dd0e54e9655eff15831839aad304bc0 (patch)
tree729814dd498ce210ecfe51be885abc843c9d1ae8 /doc
parentb83c6ab737e403fd555c6fe0e0af6abaa5a48044 (diff)
parentca1003b79178b8a01dc5fe3a14550e521a4035b0 (diff)
downloadtor-85219d887dd0e54e9655eff15831839aad304bc0.tar.gz
tor-85219d887dd0e54e9655eff15831839aad304bc0.zip
Merge remote-tracking branch 'tor-gitlab/mr/57'
Diffstat (limited to 'doc')
-rw-r--r--doc/HACKING/CodingStandards.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md
index e9bb75b986..45e33a6777 100644
--- a/doc/HACKING/CodingStandards.md
+++ b/doc/HACKING/CodingStandards.md
@@ -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