Commit 5aa58c6

watadarkstarLee-W

authored and

committed

docs: add installation and usage guide for cz-ai plugin leveraging GPT-4o

1 parent 9420b44 commit 5aa58c6Copy full SHA for 5aa58c6

File tree

+16

-0

lines changed

+16

-0

lines changed

Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,22 @@`
`3`	`3`	`In addition to the native templates, some alternative commit format templates`
`4`	`4`	are available as PyPI packages (installable with `pip`).
`5`	`5`
	`6`	`+### [cz-ai](https://github.com/watadarkstar/cz_ai)`
	`7`	`+`
	`8`	`+A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes.`
	`9`	`+`
	`10`	`+#### Installation`
	`11`	`+`
	`12`	+```sh
	`13`	`+pip install cz-ai`
	`14`	+```
	`15`	`+`
	`16`	`+#### Usage`
	`17`	`+`
	`18`	+```sh
	`19`	`+cz --name cz_ai commit`
	`20`	+```
	`21`	`+`
`6`	`22`	`### [Conventional JIRA](https://pypi.org/project/conventional-JIRA/)`
`7`	`23`
`8`	`24`	`Just like _conventional commit_ format, but the scope has been restricted to a`

Comments

(0)