diff options
| author | teor <teor@torproject.org> | 2019-11-25 12:37:26 +1000 |
|---|---|---|
| committer | teor <teor@torproject.org> | 2019-11-25 12:37:26 +1000 |
| commit | 03867b3dd71f765e5adb620095692cb41798c273 (patch) | |
| tree | 5c63373fa3e08d63f74af3c5f0b1c080951358ee /doc/HACKING | |
| parent | e6ceded7d8f241d08bc4e7eb8321b83e055e020a (diff) | |
| parent | 3d6545250e49b732292bb8ac1a3f01d198537b0b (diff) | |
| download | tor-03867b3dd71f765e5adb620095692cb41798c273.tar.gz tor-03867b3dd71f765e5adb620095692cb41798c273.zip | |
Merge branch 'maint-0.4.2'
Diffstat (limited to 'doc/HACKING')
| -rw-r--r-- | doc/HACKING/CodingStandards.md | 29 |
1 files changed, 18 insertions, 11 deletions
diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md index 34d1dd52b5..87ebbd2bec 100644 --- a/doc/HACKING/CodingStandards.md +++ b/doc/HACKING/CodingStandards.md @@ -99,17 +99,28 @@ 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 -- Major bugfixes: + o Major bugfixes (security): - Fix a potential buffer overflow. Fixes bug 99999; bugfix on 0.3.1.4-beta. + o Minor features (performance): + - Make tor faster. Closes ticket 88888. 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. 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>`. - +are: + o Minor bugfixes (subheading): + o Major bugfixes (subheading): + o Minor features (subheading): + o Major features (subheading): + o Code simplifications and refactoring: + o Testing: + o Documentation: + +The subheading is a particular area within Tor. See the ChangeLog for +examples. + +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>`. If you don't know the commit, you can search the git diffs (-S) for the first instance of the feature (--reverse). @@ -147,10 +158,6 @@ that our CI passes. These checks are implemented in `scripts/maint/lintChanges.py`. Changes file style guide: - * Changes files begin with " o Header (subheading):". The header - should usually be "Minor/Major bugfixes/features". The subheading is a - particular area within Tor. See the ChangeLog for examples. - * Make everything terse. * Write from the user's point of view: describe the user-visible changes |