Clarify commit message format in contributing guide #1643
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
RELEASE_NOTES=n/a Signed-off-by: Tom Payne <twpayne@gmail.com>
AnomalRoil
requested changes
Nov 2, 2020
|
|
||
| More detailed description of commit, if needed. | ||
|
|
||
| RELEASE_NOTES=Description for release notes, or n/a if trivial. |
There was a problem hiding this comment.
Please list the typical tags we are using:
[DOCUMENTATION], [BUGFIX], [UX], [CLEANUP], [BREAKING], [DEPRECATION], [ENHANCEMENT], [FEATURE], [TESTING]
dominikschulz
approved these changes
Nov 4, 2020
kpitt
pushed a commit
to kpitt/gopass
that referenced
this pull request
Jul 21, 2022
RELEASE_NOTES=n/a Signed-off-by: Tom Payne <twpayne@gmail.com>
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.
It took me a couple of tries to the get the commit message format right in #1642 as the CommitCheck check only states that a commit message is not valid without giving any explanation why, and the CommitCheck regular expression is not public.
This PR updates
CONTRIBUTING.mdto include a concrete example of what a commit message should look like.