doc: update docs on semantic requirements for #13359 #13365
Merged
Conversation
This file contains hidden or 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
zeke
approved these changes
Jun 21, 2018
tonyganch
approved these changes
Jun 25, 2018
| @@ -136,12 +136,12 @@ We reconcile flagged code with our versioning strategy as follows: | |||
|
|
|||
| We seek to increase clarity at all levels of the update and releases process. Starting with `2.0.0` we will require pull requests adhere to the [Conventional Commits](https://conventionalcommits.org/) spec, which can be summarized as follows: | |||
|
|
|||
| * Commits that would result in a semver **major** bump must start with `BREAKING CHANGE:`. | |||
| * Commits that would result in a semver **major** bump must start their body with `BREAKING CHANGE:`. | |||
There was a problem hiding this comment.
Just curious: what is commit's body? Commit message?
There was a problem hiding this comment.
@tonyganch I think that normally the commit message is the first line of the commit text (normally less than 80 chars) and the body is everything after that.
This right here is the commit message
Here you would add more details in the body
* Maybe
* Some
* Bullet points
And so onThere was a problem hiding this comment.
@MarshallOfSound I've already thought that the first line is a "message's summary/subject" and the rest (after an empty line) is a "message's body".
There was a problem hiding this comment.
Related: The semantic-pull-requests bot is now using the parse-commit-message module to validate commits. The API docs for that module explain commit terminology well: https://github.com/tunnckoCore/parse-commit-message#api
const { parse } = require('parse-commit-message');
const commitMsg1 = `feat(ng-list): Allow custom separator
bla bla bla
BREAKING CHANGE: some breaking change.
Thanks @foobar
`;
const commit = parse(commitMsg1);
console.log(commit);
// => { type: 'feat',
// scope: 'ng-list',
// subject: 'Allow custom separator',
// header: 'feat(ng-list): Allow custom separator',
// body: 'bla bla bla',
// footer: 'BREAKING CHANGE: some breaking change.\nThanks @stevemao' }
ckerr
approved these changes
Jul 18, 2018
Closed
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.
If #13359 gets merged we'll need to update our semantic guidelines to enforce semantic titles for PR's