Skip to content

docs: improve clarity of docs and fix typo/grammar issues #1404

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
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

bearomorphism
Copy link
Contributor

@bearomorphism bearomorphism commented May 11, 2025

Closes #1405

Description

When I first started looking into how to use this tool, I found the documentation really hard to read.
It's such a pity for such a useful tool!

Thanks to powerful AI tools, improving clarity of the documents can be easily done.

  • Rewrite README.md
  • Rewrite contributing.md
  • Fix several typos and grammar mistakes

Checklist

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and test
  • Test the changes on the local machine manually
  • Update the documentation for the changes

Expected behavior

It should be easier for the readers to understand what Commitizen does after they enter the landing page of Commitizen.

The typo of the cli output should be fixed.

Steps to Test This Pull Request

NA

Additional context

NA

Copy link

codecov bot commented May 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.57%. Comparing base (120d514) to head (9b45d55).
Report is 606 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1404      +/-   ##
==========================================
+ Coverage   97.33%   97.57%   +0.23%     
==========================================
  Files          42       57      +15     
  Lines        2104     2680     +576     
==========================================
+ Hits         2048     2615     +567     
- Misses         56       65       +9     
Flag Coverage Δ
unittests 97.57% <ø> (+0.23%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Member

@noirbizarre noirbizarre left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks !

@Lee-W
Copy link
Member

Lee-W commented May 11, 2025

Niiiice! @bearomorphism but please use docs instead of fix in the commit type, we might need your help to rebase and modify the commit message. a fix commit will automatically bump a version which is not desired in this case

@bearomorphism
Copy link
Contributor Author

bearomorphism commented May 11, 2025

@Lee-W But there's also a small behavioral change in cli.py. Is the change a fix or a docs?

@Lee-W
Copy link
Member

Lee-W commented May 11, 2025

@Lee-W But there's also a small behavioral change in cli.py. Is the change a fix or a docs?

I probably wouldn't consider it as a fix that we need to bump a version 🤔

@bearomorphism
Copy link
Contributor Author

Ok let me rebase it, thanks

@bearomorphism bearomorphism force-pushed the doc-typos branch 2 times, most recently from 6119504 to 4c1d1a1 Compare May 11, 2025 14:37
@bearomorphism bearomorphism changed the title fix(docs): typos and grammar issues docs: typos and grammar issues May 11, 2025
@bearomorphism
Copy link
Contributor Author

Let me also fix #1405 in this PR to avoid catastrophic conflicts :)

@bearomorphism bearomorphism marked this pull request as draft May 11, 2025 14:50
@bearomorphism bearomorphism changed the title docs: typos and grammar issues docs: improve clarity of README and fix typo/grammar issues May 11, 2025
@bearomorphism bearomorphism marked this pull request as ready for review May 11, 2025 16:02
@bearomorphism
Copy link
Contributor Author

@noirbizarre @Lee-W I did a lot of changes in README after your latest reviews. Please kindly review my changes again when you have a moment. Thanks!


Commitizen provides a comprehensive CLI with various commands. Here's the complete reference:

<!-- Please manually update the following section after changing `cz --help` command output. -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can probably automate this with GitHub workflow?

@bearomorphism bearomorphism force-pushed the doc-typos branch 2 times, most recently from 148b9b9 to 41fbfe2 Compare May 11, 2025 16:49
@bearomorphism bearomorphism changed the title docs: improve clarity of README and fix typo/grammar issues docs: improve clarity of docs and fix typo/grammar issues May 11, 2025
@bearomorphism
Copy link
Contributor Author

@noirbizarre @Lee-W I did a lot of changes in README after your latest reviews. Please kindly review my changes again when you have a moment. Thanks!

I also rewrote contributing.md, please review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

README.md Usage section is misleading
3 participants