rcz-0.4.16 is not a library.
rcz
A tool to write a commit message based on Conventional Commits
inspired by git-cz
Installation
Example
# bash
or
.gitconfig
Configuration
The configuration file will be automatically generated on:
- Linux:
~/.config/rcz
- Windows:
{FOLDERID_RoamingAppData}\rcz
- Mac OS:
~/Library/Preferences/rs.rcz
= '''
{type}: {subject}'''
[[]]
= 'A bug fix'
= 'fix'
= '๐'
[[]]
= 'A new feature'
= 'feat'
= 'โจ'
[[]]
= 'Changes that introduces a breaking API change'
= 'BREAKING CHANGE'
= '๐ฅ'
[[]]
= 'build system or external dependencies'
= 'chore'
= '๐ ๏ธ'
[[]]
= 'CI related changes'
= 'ci'
= '๐ซ'
[[]]
= 'Documentation only changes'
= 'docs'
= 'โ๏ธ'
[[]]
= 'Changes that do not affect the meaning of the code'
= 'style'
= '๐'
[[]]
= 'A code change that neither fixes a bug nor adds a feature'
= 'refactor'
= '๐งน'
[[]]
= ' A code change that improves performance'
= 'perf'
= '๐'
[[]]
= 'Adding or correcting tests'
= 'test'
= '๐งช'
Format
All section etc {scope}
that you can add on the format are bellow.
{type}
{emoji}
{description}
:warning: The string that enclosed in double brackets ({{echo 'foo'}}
, {{date}}
etc) is interpreted as shell script.
Other strings ({body}
, {footer}
, {header}
etc) is interpreted as a custom input.
The string is used as a prompt message.
Sometimes you don't have a scope and have to delete the brackets. If a space is entered for scope, brackets are removed altogether. #6
A example for your customize is bellow.
= '''
{type}{scope}: {emoji}{subject}
{body}
{footer}'''