Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
Tor
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Benjamin J. Thompson
Tor
Commits
03867b3d
Unverified
Commit
03867b3d
authored
5 years ago
by
teor
Browse files
Options
Downloads
Plain Diff
Merge branch 'maint-0.4.2'
parents
e6ceded7
3d654525
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/HACKING/CodingStandards.md
+18
-11
18 additions, 11 deletions
doc/HACKING/CodingStandards.md
with
18 additions
and
11 deletions
doc/HACKING/CodingStandards.md
+
18
−
11
View file @
03867b3d
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment