rcz 0.2.7

A tool to write a commit message
rcz-0.2.7 is not a library.

rcz

A tool to write a commit message based on Conventional Commits inspired by git-cz

Installation

cargo install rcz

Example

# bash
function gitk {
    git commit -m "`rcz`"
}

Configuration

The configuration file will be automatically generated on:

  • Linux: ~/.config/rcz
  • Windows: {FOLDERID_RoamingAppData}\rcz
  • Mac OS: ~/Library/Preferences/rs.rcz
format = '''
{type}: {emoji}{subject}'''

[[types]]
description = 'A bug fix'
value = 'fix'
emoji = '๐Ÿ›'

[[types]]
description = 'A new feature'
value = 'feat'
emoji = 'โœจ'

[[types]]
description = 'Changes that introduces a breaking API change'
value = 'BREAKING CHANGE'
emoji = '๐Ÿ’ฅ'

[[types]]
description = 'build system or external dependencies'
value = 'chore'
emoji = '๐Ÿ› ๏ธ'

[[types]]
description = 'CI related changes'
value = 'ci'
emoji = '๐Ÿ’ซ'

[[types]]
description = 'Documentation only changes'
value = 'docs'
emoji = 'โœ๏ธ'

[[types]]
description = 'Changes that do not affect the meaning of the code'
value = 'style'
emoji = '๐Ÿ’„'

[[types]]
description = 'A code change that neither fixes a bug nor adds a feature'
value = 'refactor'
emoji = '๐Ÿงน'

[[types]]
description = ' A code change that improves performance'
value = 'perf'
emoji = '๐Ÿš„'

[[types]]
description = 'Adding or correcting tests'
value = 'test'
emoji = '๐Ÿงช'

Format

All section etc {scope} that you can add on the format are bellow.

  • {type}
  • {emoji}
  • {subject}
  • {section}
  • {scope}
  • {body}
  • {footer}

A example for your customize is bellow.

format = '''
{type}{scope}: {emoji}{subject}
{body}
{footer}'''