docs: Expand commit-message guidelines/examples #5407
Merged
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
elwinschmitz
force-pushed
the
elwin/docs.commit-guidelines
branch
from
9b58d06
to
2eb1173
Compare
elwinschmitz
force-pushed
the
elwin/docs.commit-guidelines
branch
from
2eb1173
to
b41db96
Compare
aberonni
approved these changes
Jun 12, 2024
There was a problem hiding this comment.
I like the additions from a content perspective. Given that we are changing this, I also wanna mention that IMHO these considerations are more relevant/important on a PR level rather than on a commit level, especially given that we are using a squash merge strategy.
So, for me, I would replace:
"when committing your changes" -> "when submitting your changes through a PR"
commit message/title/first line -> PR title
commit body -> PR description
|
These considerations on "every commit" do help during code-review, I think. (at least for me writing the PR. :) ) |
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 before requesting a review