-
-
Notifications
You must be signed in to change notification settings - Fork 281
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
base: master
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks !
Niiiice! @bearomorphism but please use |
@Lee-W But there's also a small behavioral change in |
I probably wouldn't consider it as a fix that we need to bump a version 🤔 |
Ok let me rebase it, thanks |
6119504
to
4c1d1a1
Compare
Let me also fix #1405 in this PR to avoid catastrophic conflicts :) |
@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. --> |
There was a problem hiding this comment.
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?
148b9b9
to
41fbfe2
Compare
I also rewrote |
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.
Checklist
poetry all
locally to ensure this change passes linter check and testExpected 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