This is git-consistent sample.
:heavy_plus_sign: implement foo function
:sunny: fix bug
foobar
:pencil2: write README.md
emoji: | |
type: enum | |
required: true | |
description: 'commit type' | |
values: | |
- | |
name: ':heavy_plus_sign:' | |
description: 'Feature: when implementing function' | |
- | |
name: ':sunny:' | |
description: 'Fix: when fixing a bug' | |
- | |
name: ':art:' | |
description: 'Refactor: when refactoring' | |
- | |
name: ':pencil2:' | |
description: 'Doc: when writing docs' | |
- | |
name: ':white_check_mark:' | |
description: 'Test: when adding tests' | |
- | |
name: ':wrench:' | |
description: "Chore: when change other that don't modify code or test files" | |
- | |
name: ':heavy_minus_sign:' | |
description: 'Remove: when removing function' | |
- | |
name: ':rocket:' | |
description: 'Performance: when improving performance' | |
- | |
name: ':green_heart:' | |
description: 'CI: when fixing the CI build' | |
- | |
name: ':lock:' | |
description: 'Security: when dealing with security' | |
- | |
name: ':arrow_up:' | |
description: 'Up: when upgrading dependencies' | |
- | |
name: ':arrow_down:' | |
description: 'Down: when downgrading dependencies' | |
- | |
name: ':tada:' | |
description: 'Tada: when celebrating' | |
subject: | |
type: string | |
required: true | |
description: 'The subject contains succinct description of the change' | |
rules: | |
firstLetter: lower | |
dotAtEnd: false | |
nonAscii: false | |
body: | |
type: text | |
default: '' | |
required: false | |
description: 'Body' | |
rules: | |
firstLetter: upper | |
dotAtEnd: true | |
nonAscii: false |
<emoji> <subject> | |
<body> |
:heavy_plus_sign: implement foo function
:sunny: fix bug
foobar
:pencil2: write README.md