docs: add installation and usage guide for cz-ai plugin leveraging GP… #1458
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
poetry doc
locally to ensure the documentation pages renders correctlyExpected 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
Additional Context
This addition introduces a new tool to improve commit message quality and consistency by leveraging AI, which could significantly streamline developer workflows.