commitgpt
使用ChatGPT自动生成提交信息。
如何使用?
npx commitgpt
获取OpenAI API密钥
https://platform.openai.com/account/api-keys
配置(可选)
你可以在项目根目录创建.commitgpt.json
和/或.commitgpt-template
配置文件。
.commitgpt.json
文件
默认配置:
{
"model": "text-davinci-003",
"temperature": 0.5,
"maxTokens": 2048,
}
此文件可用于更改OpenAI模型和其他参数。
.commitgpt-template
文件
默认模板:
根据以下差异建议10个提交信息:
{{diff}}
提交信息应:
- 遵循常规提交规范
- 信息格式应为:<类型>[范围]: <描述>
示例:
- fix(authentication): 添加密码正则表达式模式
- feat(storage): 添加新的测试用例
此文件可用于更改生成提示请求的模板。你可以根据需要修改模板。
工作原理
- 运行
git diff --cached
- 将差异发送给ChatGPT并要求它建议提交信息
- 向用户显示建议
致谢
部分代码和方法受到以下优秀项目的启发:
- https://github.com/acheong08/ChatGPT
- https://github.com/transitive-bullshit/chatgpt-api
- https://github.com/wong2/chat-gpt-google-extension
需要API文档?请查看Redocly。