Skip to content

git commit message conventions

David Sklář edited this page Nov 3, 2017 · 1 revision

Git commit message conventions

It's strongly recommended following the Angular team Git Commit Message Conventions.

This convention allows to automate project CHANGELOG processing via grunt release task and grunt-conventional-changelog plugin.

Commit message format

(TYCHO-123) <type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Commit message header types

type description
feat feature
fix bug fix
docs documentation
style formatting, typos
refactor refactoring
test when adding missing tests
chore maintain

Commit message header pattern

Pattern is set via headerPattern option in grunt-conventional-changelog config.

/^(?:(TYCHO-\d+) )?(\w*)(?:\(([\w\$\.\-\*\/ ]*)\))?\: (.*)$/

Examples

TYCHO-3817 feat(dashboard): set `z-index`
chore(metalsmith): add `publish` option

Implement `metalsmith-publish` plugin.
chore(bower): add dependencies

Move Compass/Susy from `devDependencies` to `dependencies`.
feat(setting): update `primary` colour theme

Add `$green: #4caf50`.
refactor(dropdown): indentation

- adjust indentation
- remove obsolete code
fix(grunt): change `dist` folder structure

Update sass files path to allow distinguish loading via `includePaths` grunt-sass plugin option.

BREAKING CHANGE: change common sass files path.

Before:
`dist/common/sass`

After:
`dist/sass/common`