Clarify commit summary text for non-issue related commits #6586
Conversation
This file contains 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
Some non-issue related commits prefix the summary with "iX:". Thus if one is looking at the output of "git log" to find the required format one will come to the wrong conclusion. Make it clear in the docs what the rule is.
derekbruening
approved these changes
Jan 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Two non-issue related commits prefix the summary with "iX:". Thus if one is looking at the output of "git log" to find the required format one might come to the wrong conclusion. Make it clear in the docs what the rule is.
Also reformat the text to not be one long line.
One could do this in a separate patch, but this is just documentation.