Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
sbws
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
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
juga
sbws
Commits
2804f6be
Commit
2804f6be
authored
6 years ago
by
juga
Browse files
Options
Downloads
Patches
Plain Diff
doc: stop editing changelog on every bug/ticket
Instead create a changelog before new releases. Closes ticket #28572.
parent
9f537092
Branches
Branches containing commit
Tags
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.rst
+9
-4
9 additions, 4 deletions
CONTRIBUTING.rst
with
9 additions
and
4 deletions
CONTRIBUTING.rst
+
9
−
4
View file @
2804f6be
...
...
@@ -128,15 +128,14 @@ Any non-trivial change should contain tests. See ./TESTING.rst.
When running tests, currently ``flake8`` informs on some PEP8 errors/warnings,
but not all.
Document your changes in ./CHANGELOG.rst following `keep a changelog`_.
Reference the Tor Project Trac ticket (example: ``#12345``) or
Github ticket (example: ``GH#123``).
.. _commits-ref:
Commits
~~~~~~~~~
Each commit should reference the Tor Project Trac ticket (example: ``#12345``)
and possibly the bugfix version.
Try to make each commit a logically separate changes.::
As a general rule, your messages should start with a single line that’s
...
...
@@ -253,6 +252,12 @@ Before major releases, ensure that:
- A dirauth should be able to understand the documentation, otherwise the
documentation should be clarified.
.. _changelog:
Create a ./CHANGELOG.rst file.
Each entry should reference the Tor Project Trac ticket (example: ``#12345``)
and possibly the bugfix version.
Until version 1.0.2 we have followed `keep a changelog`_ format.
.. _commit-msg:
...
...
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