[tor-commits] [tor/master] Combine text into existing "what does not need a changes file" section.
nickm at torproject.org
nickm at torproject.org
Thu Jul 16 18:54:28 UTC 2020
commit 5f969681a0f67b3124d25a702b10796ba6f3d297
Author: Nick Mathewson <nickm at torproject.org>
Date: Thu Jul 16 14:54:17 2020 -0400
Combine text into existing "what does not need a changes file" section.
---
doc/HACKING/CodingStandards.md | 20 ++++++++------------
1 file changed, 8 insertions(+), 12 deletions(-)
diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md
index 45e33a6777..1411ff408a 100644
--- a/doc/HACKING/CodingStandards.md
+++ b/doc/HACKING/CodingStandards.md
@@ -87,18 +87,6 @@ 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
@@ -197,6 +185,14 @@ What needs a changes file?
What does not need a changes file?
* Bugfixes for code that hasn't shipped in any released version of Tor
+ * 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.
Why use changes files instead of Git commit messages?
More information about the tor-commits
mailing list