Additional header rules (header-full-stop, header-case) #547
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
byCedric
force-pushed
the
bycedric-header-rules
branch
4 times, most recently
from
72496eb to
7dadb94
Compare
This is a simplified version of the subject-full-stop rule. Headers are always present, so we don’t need to check for empty-ness. If headers are not defined, the parser will throw with an error “expecting raw commit”.
This is a simplified version of the subject-case rule. Headers are always present, so we don’t need to check for empty-ness. If headers are not defined, the parser will throw with an error “expecting raw commit”.
byCedric
force-pushed
the
bycedric-header-rules
branch
from
7dadb94 to
21bdb07
Compare
byCedric
changed the title
|
I fixed the tests and updated the documentation. I think it's ready to merge once it has been approved 😄 |
escapedcat
approved these changes
Jan 27, 2019
|
Looks good to me. |
|
Yes exactly, a conventional commit usually consists of this structure: The header itself is structured using |
|
Great! Thanks! |
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.
Description
This adds some extra, but missing, rules for header validation (#524).
Currently, there are some failing tests that need to be resolved first. But I think I might need some help/eyes to get that resolved.This PR adds two new rules for the header;
header-caseandheader-full-stop. Both are based on the already existingsubject-caseandsubject-full-stop. Like requested in #524, this is useful when no types (and therefore no subject) are used in commits.In the issue, we also discussed the
header-empty, but when using empty commit messages the parser will throw an error describing it "expects a raw commit". That makes theheader-emptyrule impossible.Motivation and ContextUsage examplesHow Has This Been Tested?
Copied and edited the tests from the existing rules.
Types of changes
Checklist: