Commits

Use following format for the commit message:

[`module`: ]`change`[{; `change`}][{\n `migration`}]

module

The module where changes occurred (math, render, etc). It can be omitted for some external changes (build scripts, configs, etc).

change

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.

migration

All breaking changes should be listed after the message on separate lines and surrounded by { }.

This information will be used to generate migration list.

examples

math: add some useful tool

math: fix some system
render: close #123, #456

render: refactor some sub-system
{
breaking changes ...
...
}