From: Roger Dingledine <arma@torproject.org>
Date: Mon, 29 Aug 2011 01:43:19 +0000 (-0400)
Subject: add another heuristic for making release notes
X-Git-Tag: tor-0.2.3.3-alpha~18
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=38881173188209db0bb9dd40bacc48aa1883f5e4;p=thirdparty%2Ftor.git

add another heuristic for making release notes
---

diff --git a/doc/HACKING b/doc/HACKING
index 9747f22651..b0689d82c1 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -426,10 +426,10 @@ interesting and understandable.
       first entry or two and the last entry most interesting: they're
       the ones that skimmers tend to read.
 
-   2.4) Clean them up
+   2.4) Clean them up:
 
    Standard idioms:
-     "Fixes bug 9999; Bugfix on 0.3.3.3-alpha."
+     "Fixes bug 9999; bugfix on 0.3.3.3-alpha."
 
    One period after a space.
 
@@ -446,6 +446,11 @@ interesting and understandable.
 
    Present and imperative tense: not past.
 
+   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
+   new stable releases.
+
    If a given changes stanza showed up in a different release (e.g.
    maint-0.2.1), be sure to make the stanzas identical (so people can
    distinguish if these are the same change).