Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

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

Merged
Lee-W merged 20 commits into commitizen-tools:master from bearomorphism:doc-typos
May 28, 2025

Conversation

Copy link
Contributor

@bearomorphism bearomorphism commented May 11, 2025 •
edited
Loading

Closes #1405
Closes #1413

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 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.57%. Comparing base (120d514) to head (361e977).
Report is 648 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 2682 +578 
==========================================
+ Hits 2048 2617 +569 
- 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 !

bearomorphism reacted with heart emoji
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

Copy link
Contributor Author

bearomorphism commented May 11, 2025 •
edited
Loading

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

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 🤔

Copy link
Contributor Author

Ok let me rebase it, thanks
Lee-W reacted with heart emoji

@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
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
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!

@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 bearomorphism force-pushed the doc-typos branch 3 times, most recently from 4b7a7cd to 2cc458e Compare May 11, 2025 19:30
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

Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

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

I'm good with what we currently have in this PR. The docs look so nice. But it would be awesome if we could have some of the minor nit-picks addressed 🙂

@Lee-W Lee-W removed the pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check label May 18, 2025
Copy link
Contributor Author

I fixed the issues in README, please review, thanks!

Copy link
Member

Lee-W commented May 22, 2025

@noirbizarre I think we're making enough improvements in this one. I'm thinking of merging it and leaving the rest for a future update. WDYT?

@Lee-W Lee-W added pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check and removed pr-status: wait-for-review labels May 22, 2025
Copy link
Member

Lee-W commented May 28, 2025

I believe this PR significantly improves our documentation, and the comments have been addressed. I'm going to merge it without waiting. Hope it's ok. Thanks!

@Lee-W Lee-W merged commit bb1539d into commitizen-tools:master May 28, 2025
18 checks passed
@bearomorphism bearomorphism deleted the doc-typos branch June 1, 2025 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lee-W Lee-W Lee-W approved these changes

@woile woile Awaiting requested review from woile woile is a code owner

@noirbizarre noirbizarre Awaiting requested review from noirbizarre noirbizarre is a code owner

Assignees
No one assigned
Labels
pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Inject the output of cz --help into README with GitHub workflow README.md Usage section is misleading

AltStyle によって変換されたページ (->オリジナル) /