This project will use Conventional Commits v1.0.0.
| Type | Usage | Version | Header |
|---|---|---|---|
feat |
new feature for the user, not a new feature for build script | MINOR | Features |
fix |
bug fix for the user, not a fix to a build script | PATCH | Bugfixes |
assets |
only artwork: icons, images, but not css (those belong to style) |
||
build |
changes that affect the build system (conan, cmake, later yarn) or external dependencies | ||
chore |
updating grunt tasks etc; no production code change | ||
ci |
changes to CI configuration files and scripts (GitHub actions) | ||
docs |
changes to the documentation | ||
perf |
performance improvement for the user | ||
refactor |
refactoring production code, eg. renaming a variable | ||
revert |
neither fixing a bug nor adding a feature | ||
style |
formatting, missing semi colons, etc; no production code change | ||
test |
adding missing tests, refactoring tests; no production code change |
| Scope | Usage |
|---|---|
lang |
either .lang or .po files |
api |
cov-api library |
lighter |
any of the hilite libraries |
app |
app library |
rt |
cov-rt library |
core |
cov and builtins |
cmake, conan, yarn |
for build |
server |
changes to beast code, but not routes |
ws or rest |
changes to C++ half of communication |
webapp |
changes to React half of communication |
Additionally, after v1.0.0 release, any breaking change will have a ! appended to type/scope and BREAKING CHANGE: <description> in the message footer.
- uses the imperative, present tense: “change” not “changed” nor “changes”
- includes motivation for the change and contrasts with previous behavior
Closed issues should be listed on a separate line in the footer prefixed with "Closes" header like this:
Closes: #234
or in the case of multiple issues:
Closes: #123, #245, #992
Referenced, but not closed issues should use "Refs" footer header:
Refs: #123, #245, #992
All breaking changes have to be mentioned in footer with the description of the change, justification and migration notes. This should be the last part of a commit message.
BREAKING CHANGE:
`port-runner` command line option has changed to `runner-port`, so that it is
consistent with the configuration file syntax.
To migrate your project, change all the commands, where you use `--port-runner`
to `--runner-port`.