Skip to content

Use case: conventional commit messages as default #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
vknabel opened this issue Aug 1, 2023 · 1 comment
Open

Use case: conventional commit messages as default #6

vknabel opened this issue Aug 1, 2023 · 1 comment

Comments

@vknabel
Copy link

vknabel commented Aug 1, 2023

The idea is to generate conventional commit messages based on the current git diff.

On top of that, it should also generate a description (body + footer) as developers tend to not value them enough.

@codergeek121
Copy link
Owner

In general I really like the idea to have support for specific development tasks, I'd be totally in favor of adding a feature like this.

I like the commit description idea.
I think most of the times, taking the time to write a super detailed commit messages is not worth the time. BUT! if I would get a good prewritten message, proofreading it before committing seems like way faster, so this feature makes total sense to me.

Your suggestion would be, that the LLM decides itself if it's a fix, feature or chore, correct?

I'd build the first draft of this feature as follows:

// in git repo
echo "Hello World" > README.MD

git add README.MD

// If possible, would open the commit editor with a prefilled correctly formatted git message
clai commit

The clai commit command should also support the --persona option and it should be possible to specify a default persona for specific commands. Generating conventional commit messages is probably doable with a persona and the following prompt You follow the conventional commit format or sth. similar.

In general, the most important thing is, that every command in clai has actual users using the command and that it actually saves time. For me using clai session to quickly look something up is way fast than googling.

Would you use clai commit with the workflow proposed above?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants