Skip to content

README.md Usage section is misleading #1405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
1 of 3 tasks
bearomorphism opened this issue May 11, 2025 · 1 comment · May be fixed by #1404
Open
1 of 3 tasks

README.md Usage section is misleading #1405

bearomorphism opened this issue May 11, 2025 · 1 comment · May be fixed by #1404
Assignees
Labels

Comments

@bearomorphism
Copy link
Contributor

bearomorphism commented May 11, 2025

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.

@Lee-W
Copy link
Member

Lee-W commented May 11, 2025

It might be there before we formalize our workflow. And if we could deduplicate things, that's even better!

@bearomorphism bearomorphism linked a pull request May 11, 2025 that will close this issue
4 tasks
bearomorphism added a commit to bearomorphism/commitizen that referenced this issue May 11, 2025
bearomorphism added a commit to bearomorphism/commitizen that referenced this issue May 11, 2025
bearomorphism added a commit to bearomorphism/commitizen that referenced this issue May 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants