More details about commit messages in contributing.md #4598
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
It's generally more useful to say something like "revset: use Self to refer to expressions of the same type" than "lib: use Self to refer to revset expressions of the same type ", so let's try to clarify that.
We didn't have any guidelines about what to include in a commit message. Others have already written good guides for that. This commit adds a link to one. I also added a sentence about explaining the reason for a change, since I think that's particularly often missed (I'm sure I also miss it sometimes - don't hesitate to point out when that happens).
PhilipMetzger
approved these changes
Oct 7, 2024
ilyagr
approved these changes
Oct 7, 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.
Checklist
If applicable:
CHANGELOG.md