From 8a647291c837846dca73c2017d3101621fd25a8d Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Wed, 19 Mar 2014 20:24:15 -0400 Subject: extract some changelog principles into doc/HACKING --- doc/HACKING | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc') diff --git a/doc/HACKING b/doc/HACKING index 3c1d0d957..ea7d82d5f 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 -- cgit v1.2.3