torproject/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-12-06 19:41:15 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

add another heuristic for making release notes

Browse Source
This commit is contained in:
Roger Dingledine
2011-08-28 21:43:19 -04:00
parent 0f38feaf89
commit 3888117318
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/HACKING
+7 -2
View File
@@ -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).