realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-15 02:33:15 +02:00
Code Issues Packages Projects Releases Wiki Activity
kicad-source/Documentation/development/commit-message-format.md
Maciej Suminski f9fd60350f Documentation: added a note about changelog tags
2017-11-29 10:44:47 +01:00

2.5 KiB
Raw Blame History

Commit Message Format

[TOC]

Commit messages should begin with a subject line; try to limit this to no more than 50-72 characters. The body of the message should be separated from the subject by a blank line and wrapped at 72 characters. The body of a commit message should explain what the commit does and why, but do not explain how as the code itself should do that.

Linking a commit to a bug report

If your commit fixes a bug that has been reported in the Launchpad bug tracker, end your commit with the following lines to mark it as fixed, where 1234567 represents the actual bug ID. A bot will automatically set the bug status to "Fix Committed" and link to the commit once it is merged.

Fixes: lp:1234567
https://bugs.launchpad.net/kicad/+bug/1234567

Helper alias for linking to bugs

There is a helper alias located at helpers/git/fixes_alias to simplify adding these links. To install it, run in the source repository:

git config --add include.path $(pwd)/helpers/git/fixes_alias

Once the alias is installed, it may be used to amend the most recent commit to include the bug report link:

git fixes 1234567

Changelog tags

To facilitate following the code changes, you should include a changelog tag to indicate modifications noticable by the users. There are three types of changelog tags:

  • NEW to denote a new feature
  • CHANGED to indicate a modification of an existing feature
  • 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.

When a commit with changelog tags is pushed, the committer should create a new issue in the documentation repository to notify the documentation maintainers. You should include a link to the commit containing the reported changes.

Example

Following is an example of a properly formatted commit message:

Eeschema: Adding line styling options

NEW: Adds support in eeschema for changing the default line style,
width and color on a case-by-case basis.

CHANGED: "Wire" lines now optionally include data on the line style,
width and color if they differ from the default.

Fixes: lp:594059
* https://bugs.launchpad.net/kicad/+bug/594059

Fixes: lp:1405026
* https://bugs.launchpad.net/kicad/+bug/1405026