haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add explaining notes on when to use changelog tags

This commit is contained in:
Nick Østergaard 2017-11-29 16:54:18 +01:00 committed by Maciej Suminski
parent c5254bfec2
commit 4e8e6d4823
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/development/commit-message-format.md
View File

@ -32,7 +32,10 @@ changelog tags:
- `REMOVED` to inform about removal of an existing feature
There is no need to add changelog tags for commits that do not modify the way
the users interact with the software, such as code refactoring.
the users interact with the software, such as code refactoring or a bugfix for
unexpected behavior. The main purpose of the changelog tags is to generate the
release notes and notify the documentation maintainers about changes. Keep that
in mind when deciding whether to add a changelog tag.
When a commit with changelog tags is pushed, the committer should create a new
issue in the [documentation