Automatically generate commit messages using ChatGPT.
npx commitgpt
https://platform.openai.com/account/api-keys
you can create .commitgpt.json and/or ..commitgpt-template config files in your project root.
.commitgpt.json filedefault:
{
"model": "text-davinci-003",
"temperature": 0.5,
"maxTokens": 2048,
}
this file can be used to change the openai model and other parameters.
.commitgpt-template filedefault:
suggest 10 commit messages based on the following diff:
{{diff}}
commit messages should:
- follow conventional commits
- message format should be: <type>[scope]: <description>
examples:
- fix(authentication): add password regex pattern
- feat(storage): add new test cases
this file can be used to change the template used to generate the prompt request. you can modify the template to fit your needs.
git diff --cachedSome code and approaches were inspired by the awesome projects below:
Do you need API docs? Check out Redocly.
FAQs
Automatically generate commit messages using ChatGPT.
We found that commitgpt demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.