-
Notifications
You must be signed in to change notification settings - Fork 3
Commits
vsergey3d edited this page Sep 21, 2014
·
1 revision
Use following format for the commit message:
[`module`: ]`change`[{; `change`}][{\n `migration`}]
The module where changes occurred (math, render, etc). It can be omitted for some external changes (build scripts, configs, etc).
Try to use one sentence to describe the change. Prefix the sentence with the common verb:
-
add
- added something (files, modules, public APIs, etc.) -
remove
- removed something -
refactor
- refactored something -
fix
- fixed bug -
update
- irrelevant changes (typo, reformatting, etc.) -
merge
- merged commit -
close
- closed issues (message should be: #N[, #N, ...])
This information will be used to generate change log
.
All breaking changes should be listed after the message on separate lines and surrounded by {
}
.
This information will be used to generate migration
list.
math: add some useful tool
math: fix some system
render: close #123, #456
render: refactor some sub-system
{
breaking changes ...
...
}