diff options
Diffstat (limited to 'doc/HACKING')
| -rw-r--r-- | doc/HACKING | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/HACKING b/doc/HACKING index 4eee914ba..d8538b1f2 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -50,14 +50,14 @@ 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 - o Major bugfixes: - - Fix a potential buffer overflow. Fixes bug 9999. Bugfix on - Tor 0.3.1.4-beta. + o Major bugfixes: + - Fix a potential buffer overflow. Fixes bug 9999; bugfix on + 0.3.1.4-beta. To write a changes file, first categorize the change. Some common categories are: Minor bugfixes, Major bugfixes, Minor features, Major features, Code -simplifications and refactoring. Then say what the change does. Then, if -it's a bugfix, then mention what bug it fixes and when the bug was +simplifications and refactoring. Then say what the change does. If +it's a bugfix, mention what bug it fixes and when the bug was introduced. To find out which Git tag the change was introduced in, you can use "git describe --contains <sha1 of commit>". |