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: add installation and usage guide for cz-ai plugin leveraging GP... #1458

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 1 commit into commitizen-tools:master from watadarkstar:patch-1
May 27, 2025

Conversation

Copy link
Contributor

@watadarkstar watadarkstar commented May 26, 2025 •
edited
Loading

Description

Add documentation for a new cz-ai commitizen plugin, including installation and usage instructions. This plugin leverages OpenAI’s GPT-4o to generate conventional commit messages automatically from staged git changes.

Closes #670

Checklist

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly

Expected Behavior

The documentation should clearly explain how to install and use the cz-ai plugin to generate conventional commit messages automatically.

Steps to Test This Pull Request

  1. Build the documentation locally (e.g., run poetry doc)
  2. Verify the new section for cz-ai appears correctly with installation and usage commands
  3. Optionally, install the plugin and try the usage command to confirm instructions are accurate

Additional Context

This addition introduces a new tool to improve commit message quality and consistency by leveraging AI, which could significantly streamline developer workflows.

Screenshot 2025年05月26日 at 8 12 11 PM

Copy link

codecov bot commented May 26, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.62%. Comparing base (120d514) to head (87a48a4).
Report is 627 commits behind head on master.

Additional details and impacted files 
@@ Coverage Diff @@
## master #1458 +/- ##
==========================================
+ Coverage 97.33% 97.62% +0.28% 
==========================================
 Files 42 57 +15 
 Lines 2104 2653 +549 
==========================================
+ Hits 2048 2590 +542 
- Misses 56 63 +7
Flag Coverage Δ
unittests 97.62% <ø> (+0.28%) ⬆️

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

Lee-W commented May 27, 2025

@watadarkstar Thanks! Looks good to me. Loop @bearomorphism in as I guess you might been interested in it?
bearomorphism reacted with eyes emoji

@Lee-W Lee-W merged commit 5aa58c6 into commitizen-tools:master May 27, 2025
18 checks passed
Copy link
Contributor Author

Thanks @Lee-W ! If you or @bearomorphism have any feedback feel free to DM me on X https://x.com/icookandcode

bearomorphism reacted with eyes emoji

Copy link
Contributor

Thanks @Lee-W ! If you or @bearomorphism have any feedback feel free to DM me on X https://x.com/icookandcode

Thanks! My X account has been broken recently though.
Lee-W reacted with eyes emoji

Copy link
Contributor Author

Thanks @Lee-W ! If you or @bearomorphism have any feedback feel free to DM me on X https://x.com/icookandcode

Thanks! My X account has been broken recently though.

No worries I'm also on Linkedin, Discord, etc. Just let me know what platform works for you and I can send you my details.

Copy link
Contributor

Oh my x account is back

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
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Writes git commit messages with AI

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