docs: small changes to contibting.md #38137
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -197,7 +197,7 @@ When the body is required it must be at least 20 characters long. | |
|
|
||
| The `footer` is optional. | ||
|
|
||
| Any line of the commit message cannot be longer than 120 characters. | ||
|
|
||
|
|
||
| #### <a href="commit-header"></a>Commit Message Header | ||
|
|
@@ -302,12 +302,13 @@ You can include a comparison of the previous behavior with the new behavior in o | |
| The footer can contain information about breaking changes and is also the place to reference GitHub issues, Jira tickets, and other PRs that this commit closes or is related to. | ||
|
|
||
| ``` | ||
| Fixes #<issue number> | ||
|
|
||
| BREAKING CHANGE: <breaking change summary> | ||
| <BLANK LINE> | ||
| <breaking change description + migration instructions> | ||
| <BLANK LINE> | ||
| <BLANK LINE> | ||
|
Member
There was a problem hiding this comment. You are right that we used to require the issue/PR references to be above the breaking change notice, but this has changed recently. So, putting the |
||
| ``` | ||
|
|
||
| Breaking Change section should start with the phrase "BREAKING CHANGE: " followed by a summary of the breaking change, a blank line, and a detailed description of the breaking change that also includes migration instructions. | ||
|
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, we want each line to have max. 100 chars. The current limit of 120 is supposed to be a "temporary" work-around that we seem we to have forgotten to revert: bf57df3
Maybe you could try reverting that to 100 and see if CI is indeed happy.