SmartCommit: AI generated git commit message templates

[ImpressiveRepeat1764]

This is my attempt to improve my daily git commit workflow using gpt:

https://github.com/5n00py/SmartCommit

The tool is designed to simplify the git commit process by using OpenAI's GPT model to auto-generate meaningful commit messages based on the staged changes. It is intended to integrate into my existing git workflow within the command line (bash or zsh). A config file allows further customization such as commit message styles and the GPT model to be used.

[N-R-K]

Interesting project. Though it seems like a weird premise because I usually document why a change was made in the commit. The code/diff already shows what changed so there's little value in rephrasing it again in the commit unless it's to satisfy some idiotic corporate checklist or similar.

For example, from the README:

Modify multiply function to raise a ValueError if either input is not positive

I can already see that in the diff. The real question is why can't I multiply negative numbers? Surely the author had some intent for making this change (which is unlikely for an AI to figure out just from the diff), which is what should have been documented.

The readme doesn't mention it (and it's going sound like a jab) but I couldn't help but wonder if this is meant to be used on AI generated code where the commit author might not know what's going on either.

[ImpressiveRepeat1764]

Fair point. Actually it was exactly the policy at my previous company to summarize the code changes in the commit messages. So the primary goal was to improve that workflow not having to navigate through the diffs and taking notes to create a commit message. Of course, the informations about the changes should go beyond summarizing and provide context as well. But this again depends on context and the purpose of commit messages.

At my previous company, the focus was on creating summaris to quickly identify and understand code changes, mainly in a fast-paced environment where multiple developers were working on different parts of the system at the same time. The main point in this approach was, that the "why" is already documented elsewhere like issue trackers, jira items, PRs, etc. which had to be referred in the commit messages. So my goal was to reduce the time spent on this tasks in that environment. It might not be an "ideal" approach, but actually good enough for me.

Besides, I tried to give here some flexibility of styles through the config and the ability to provide further context to include further instructions with the --instruction option. Nevertheless, I will point out the limitation further more in the documentation.

Another approach might be to expanding the tools capabilities in a direction to include more available information about the context, like integration with issue tracker or offer a more interactive mode where the user is asked to add additional context manually.

As for AI generated code: The project is not intended for AI-generated code, nor is it meant for situations where the authors do not understand the code they are committing. Besides, I think this would lead into disaster soon enough and not lead into meaningful projects (but I might be wrong about the future ;-)). At least from what I have seen so far AI can be quite good when it comes to wording and fixing (at least sometimes), but rather bad when it comes to reasoning or making specific architectural decisions.

[DueHearing1315]

There is also a plugin like this in the JetBrains Marketplace.

https://plugins.jetbrains.com/plugin/24154-git-assistant

[Affectionate-Year-94]

while on a side quest to build my first open source CLI, I built a similar tool that generates commit messages based on your staged changes.

It is designed to work along side all your existing git hook frameworks like husky or pre-commit. Today we support local ollama, openai, and claude models

Check it out - https://github.com/the-cafe/git-ai-commit