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
4851d077
Commit
4851d077
authored
6 years ago
by
Matt Traudt
Browse files
Options
Downloads
Patches
Plain Diff
Add changelog to docs, add info about it in contributing
parent
2c895185
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
CONTRIBUTING.rst
+11
-0
11 additions, 0 deletions
CONTRIBUTING.rst
docs/source/CHANGELOG.md
+1
-0
1 addition, 0 deletions
docs/source/CHANGELOG.md
docs/source/index.rst
+1
-0
1 addition, 0 deletions
docs/source/index.rst
with
13 additions
and
0 deletions
CONTRIBUTING.rst
+
11
−
0
View file @
4851d077
...
...
@@ -52,6 +52,15 @@ approxmiately all sbws configuration options and can be changed with an sbws
update. The latter is used as a starting point for generating a client's
``config.ini`` and changes to it only affect newly generated config files.
**Document your addition, fix, change, or whatever in the changelog**. See
`keep a changelog`_ for the standard we follow. Of note, add Added, Changed,
Deprecated, Removed, Fixed, and Security headings as needed in the Unreleased
section. **If your change has a trac or GitHub ticket, reference it** like
``(GH#123)`` or ``(trac#22104)``. When it comes time to do a release, the
person doing the release should (1) change the name of the Unreleased section
and add a new one, and (2) update the links at the bottom.
.. _commit-msg:
Example commit message
...
...
@@ -89,3 +98,5 @@ With thanks to `Tim Pope`_:
.. _pull request: https://github.com/pastly/simple-bw-scanner/compare
.. _tim pope: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
.. _`keep a changelog`: https://keepachangelog.com/en/1.0.0/
This diff is collapsed.
Click to expand it.
docs/source/CHANGELOG.md
0 → 120000
+
1
−
0
View file @
4851d077
../../CHANGELOG.md
\ No newline at end of file
This diff is collapsed.
Click to expand it.
docs/source/index.rst
+
1
−
0
View file @
4851d077
...
...
@@ -18,6 +18,7 @@ Contents
INSTALL
DEPLOY
README
CHANGELOG
CONTRIBUTING
AUTHORS
LICENSE
...
...
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