README.md

emotional

A Commitizen template for conventional commit with emojis and integrations.

Installation

pip install emotional

Then set emotional as the Commitizen template:

[tool.commitizen]
name = "emotional"

Configuration

As a starter, remember that all Commitizen configuration is available.

Changelog

By default, changes by types are kept in order of commit and ignore the scope for ordering. You can however force scope to be sorted first by setting order_by_scope:

[tool.commitizen]
name = "emotional"
order_by_scope = true

You can also group changes into subsections by scope by setting group_by_scope:

[tool.commitizen]
name = "emotional"
group_by_scope = true

Github integration

To enable github integration, just provide your github repository as github setting:

[tool.commitizen]
name = "emotional"
github = "author/repository"

For github enterprise, you can use the full repository URL:

[tool.commitizen]
name = "emotional"
github = "https://git.company.com/author/repository"

Gitlab integration

To enable gitlab integration, just provide your gitlab repository as gitlab setting:

[tool.commitizen]
name = "emotional"
gitlab = "author/repository"

Use the full URL for hosted gitlab instances:

[tool.commitizen]
name = "emotional"
gitlab = "https://git.company.com/author/repository"

Jira integration

To enable Jira integration, provide your JIRA instance URL as jira_url setting and the list of project prefix you want ho be processed in jira_prefixes:

[tool.commitizen]
name = "emotional"
jira_url = "https://emotional.atlassian.net"
jira_prefixes = [
  "EMO-",
  "PRJ-",
]

Multiple integrations

While it is totally possible to mix integrations, keep in mind than jira is compatible with both github and gitlab while github and gitlab are conflicting because they use the same format.