1.9 KiB
Commit guidelines
Template
Commit messages should match the following template:
TYPE:MESSAGE
DESCRIPTION
TYPE
TYPE can have one of the following values:
| value | meaning |
|---|---|
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| docs | Documentation only changes |
| feat | A new feature |
| fix | A bug fix |
| perf | A code change that improves performance |
| refactor | A code change that neither fixes a bug nor adds a feature |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| test | Adding missing tests or correcting existing tests |
These are the types, that angular uses. They are easily adaptable for all TypeScript based web related projects.
MESSAGE
MESSAGE should complete a sentence that starts with "This commit will...".
The first line of the commit message should not be longer than 50 chars overall.
DESCRIPTION
DESCRIPTION can contain a longer description of the commit. Each line should not be longer than 70 chars. New lines can be used to structure the description.
To reference or close issues GitLab keywords can be used in the last line(s) of the description:
Fixes #42
or
References #42
Advantages
The result of those commit guidelines is a concise and clear history of the development.
Another advantage is the automatic generation of a changelog that gives an overview of the changes.
conventional-changelog -p angular -i CHANGELOG.md -s -r 0