[tor-commits] [tor/master] extract some changelog principles into doc/HACKING
nickm at torproject.org
nickm at torproject.org
Thu Mar 20 00:24:19 UTC 2014
commit 8a647291c837846dca73c2017d3101621fd25a8d
Author: Nick Mathewson <nickm at torproject.org>
Date: Wed Mar 19 20:24:15 2014 -0400
extract some changelog principles into doc/HACKING
---
doc/HACKING | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/doc/HACKING b/doc/HACKING
index 3c1d0d9..ea7d82d 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -474,6 +474,10 @@ interesting and understandable.
Present and imperative tense: not past.
+ 'Relays', not 'servers' or 'nodes' or 'Tor relays'.
+
+ "Stop FOOing", not "Fix a bug where we would FOO".
+
Try not to let any given section be longer than about a page. Break up
long sections into subsections by some sort of common subtopic. This
guideline is especially important when organizing Release Notes for
More information about the tor-commits
mailing list