Skip to content

README.md Usage section is misleading #1405

Open
@bearomorphism

Description

@bearomorphism

Type

  • Content inaccurate
  • Content missing
  • Typo

URL

commitizen/docs/README.md

Lines 100 to 112 in be02801

## Usage
Most of the time this is the only command you'll run:
```sh
cz bump
```
On top of that, you can use commitizen to assist you with the creation of commits:
```sh
cz commit
```

Description

I find this section of the README a bit misleading.

It’s somewhat inconsistent with what’s described in Getting Started and some of the YouTube tutorials.

Personally, the commands I use most often are cz c or cz c -a.
I only run cz bump after a series of feat/fix commits — or even let GitHub workflow handle it automatically.

I think it might be better to either move the entire section from Getting Started over here, or just keep a single line like:
“Read more in the section Getting Started.”

Otherwise, it's likely for the two sections of docs to diverge over time.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions