CONTRIBUTING.md: Clarify clarification on periods #48179
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
Commit 9428c28 added a note in `CONTRIBUTING.md` saying that, "For consistency, there should not be a period at the end of the commit message." I believe it would be more correct (with respect to consistency) to say that there should not be a full stop/period at the end of the commit message's *summary line* (the first line of the commit message) (indeed, the example commit message just above this note clearly does use full stops outside of its summary line), and this patch changes `CONTRIBUTING.md` accordingly.
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.
Commit 9428c28 added a note in
CONTRIBUTING.mdsaying that, "For consistency, there should not be a period at the end of the commit message."I believe it would be more correct (with respect to consistency) to say that there should not be a full stop/period at the end of the commit message's summary line (the first line of the commit message)
(indeed, the example commit message just above this note clearly does use full stops outside of its summary line), and this patch changes
CONTRIBUTING.mdaccordingly.Motivation for this change
Things done
sandboxinnix.confon non-NixOS)nix-shell -p nox --run "nox-review wip"./result/bin/)nix path-info -Sbefore and after)