Skip to content

Add concise example when choosing a commit rule in cz init #1822

@namwoam

Description

@namwoam

Description

When a new user initializes cz in a Git repository, they are prompted to choose a commit rule. However, it isn’t clear how each rule translates into an actual commit message. Providing a simple concise documentation a at this step would help clarify the differences and reduce user friction.

Possible Solution

No response

Additional context

? Please choose a supported config file:  pyproject.toml
? Please choose a cz (commit rule): (default: cz_conventional_commits) (Use arrow keys)
 » cz_conventional_commits
   cz_customize
   cz_jira <- should have documentation when hover over it

Related issues

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions