Skip to content
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

Commit messages missing useful detail #68

Open
rossigee opened this issue Oct 8, 2024 · 5 comments · Fixed by #69
Open

Commit messages missing useful detail #68

rossigee opened this issue Oct 8, 2024 · 5 comments · Fixed by #69
Labels
enhancement New feature or request

Comments

@rossigee
Copy link
Contributor

rossigee commented Oct 8, 2024

Would be great if commit messages could more information on the change made.

Currently, my commit log history for kobold-managed repos contains chore(kobold): reponame repeated for each commit. If it also noted which tags have changed I wouldn't have to drill into each commit to determine which one I'm looking for.

@bluebrown
Copy link
Owner

Yeah, in my first implementation the user could supply their own template and range over the changes.

n V2 I ignored it at first but people wanted it. So what is there isnt ideal. In the perfect world we probably bring the template back.

Because the way the message is currently, is more or less from another user PR. So what you consider useless is maybe exactly what someone else wants. A template would maybe satisfy both.

@bluebrown bluebrown added the enhancement New feature or request label Oct 9, 2024
@bluebrown
Copy link
Owner

bluebrown commented Oct 9, 2024

Also this one here

// TODO: use top level loop to capture the current source file info.

It is there because I was anticipating commit messages at this point. I knew from my first implementation that you want to capture the position of the image, when doing good commit messages. Because you can have the same image multiple times, say a migration job and the apllication itself use the same image with a different command.

So in my opinion, if you want to do it correct, you need to capture some more context, like file and even more specific position in the file, say document index, and container name.

@bluebrown
Copy link
Owner

But then on the other hand, too much details is maybe also pointless. I can just look at the commit itself. Anything I write in the body and not the commit title, I cannot view in the ui anyway. At least not in mine.

But then were is the line? Like can you drop the entire body with that argumentation? If so then the title is capped to 50 chars, so cant pack too much info in there either.

This kind of thinking was why v2 didnt even have any image names or anything in the title. Title is too short to be useful. body is not useful because I need to open the commit to see it, in which case I can see the changes itself.

@rossigee
Copy link
Contributor Author

rossigee commented Oct 9, 2024

So what you consider useless is maybe exactly what someone else wants. A template would maybe satisfy both.

Agreed. That would be the ideal solution.

@rossigee rossigee closed this as completed Oct 9, 2024
@bluebrown
Copy link
Owner

I like to keep the issue open under the points I have mentioned. Doesnt mean to you have to be invloved but I dont want to repeat myself somewhere else. The issue itself is the right place too, in my opinion.

@bluebrown bluebrown reopened this Oct 9, 2024
@bluebrown bluebrown reopened this Oct 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants