docs: clarify commit message guidance#195
Merged
Merged
Conversation
The guidance needs a clear split between what changed and why it matters. That keeps future agent commits useful without overloading the subject. The trade-off is a flexible rule rather than a rigid template. The side effect is that commit bodies should name relevant design trade-offs and side effects when the subject alone is insufficient.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The guidance needs a clear split between what changed and why it matters. That keeps future agent commits useful without overloading the subject.
The trade-off is a flexible rule rather than a rigid template. The side effect is that commit bodies should name relevant design trade-offs and side effects when the subject alone is insufficient.