Re: [PATCH] sequencer: make it clearer that commit descriptions are just comments

From: Reto <reto@slightlybroken.com>
Date: May 15, 2025, 04:42 UTC
Message-ID: <5voz3jolpff7wbs5yg7jvz5dt7omcikhna7j7646veagr63quv@kkxhzxxf4uf2>
In-Reply-To: <pull.1923.git.1747275627422.gitgitgadget@gmail.com>

On Thu, May 15, 2025 at 02:20:27AM +0000, Elijah Newren via GitGitGadget wrote:

Show 5 quoted lines

> Every once in a while, users report that editing the commit summaries
> in the todo list does not get reflected in the rebase operation,
> suggesting that users are (a) only using one-line commit messages, and
> (b) not understanding that the commit summaries are merely helpful
> comments to help them find the right hashes.

As with everything in git, you can learn that this is the case. You could as well just add a explanatory comment to the footer.

Show 5 quoted lines

> It may be difficult to correct users' poor commit messages, but we can
> at least try to make it clearer that the commit summaries are not
> directives of some sort by inserting a comment character.  Hopefully
> that leads to them looking a little further and noticing the hints at
> the bottom to use 'reword' or 'edit' directives.

For fancy things/editors that recognize comments, this will *dim* the commit messages, to light grey or such. This is decidedly not what I'd like to happen at least. The commit messages there are my primary way of navigating the commit, given that I'm not learning the commit shas by hard ;)

While I appreciate the motivation, I don't think the comment string is a good approach here.

Cheers, Reto