-
Notifications
You must be signed in to change notification settings - Fork 362
Description
Git supports commit trailers and tag trailers — semi-structured metadata appended to the end of a commit message or a tag description. This mechanism can be used, for example, to add the identifier of the related issue, the target version, the names of co-authors or testers, and similar information.
A more detailed description of possible use cases can be found here:
- https://alchemists.io/articles/git_trailers
- https://www.graphapp.ai/engineering-glossary/git/git-commit-trailers
Git provides the git interpret-trailers subcommand for working with trailers.
It would be beneficial to add trailer support to the commit screen. In my view, it would be sufficient to include a table where users can enter key–value pairs. Optionally, the repository could allow configuration (similarly to how commit message templates are configured) of commonly used trailer keys.
A similar feature could also be added to the tag creation form.
For displaying commits, I do not think any special support is necessary. It is sufficient for trailers to appear at the end of the commit message exactly as they are physically stored.
The primary intended purpose is to make it easier for users to enter trailer keys correctly.
It is common for trailers to be processed automatically afterward, so the exact key name matters — for example, whether the trailer is named issue, Issue, issueRef, or Issue-reference. The goal is therefore to allow users to easily add the trailers used in a given project to the message, with the correct naming and spelling.
Instead of a more complex table for managing a list of trailers, it would also be possible to use a button with a dropdown menu of commonly used trailers, which would insert the correct key at the end of the message.