hyro/website
1
0
Fork 0
mirror of https://github.com/xHyroM/website.git synced 2024-09-20 05:13:19 +02:00
Code Issues Projects Releases Wiki Activity Actions

docs: add more info into commit footer, excalation amrks

Browse source
This commit is contained in:
xHyroM 2023-01-05 13:19:01 +01:00
parent f23066264f
commit a5bd3cd7b2
1 changed files with 15 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
CONTRIBUTING.md
View file

@ -25,9 +25,11 @@ The `footer` is optional. The [Commit Message Footer](#commit-footer) format des
#### <a name="commit-header"></a>Commit Message Header #### <a name="commit-header"></a>Commit Message Header
``` ```
<type>(<scope>): <short summary> <type>(<scope>)(!?): <short summary>
│ │ │ │ │ │ │
│ │ └─⫸ Summary in present tense. Not capitalized. No period at the end. │ │ │ └─⫸ Summary in present tense. Not capitalized. No period at the end.
│ │ │
│ │ └─⫸ Exclamation mark: breaking change
│ │ │ │
│ └─⫸ Commit Scope: layouts|components|components-widgets|components-atoms|pages │ └─⫸ Commit Scope: layouts|components|components-widgets|components-atoms|pages
│ pages-blog|pages-docs|scripts|assets │ pages-blog|pages-docs|scripts|assets
@ -36,6 +38,7 @@ The `footer` is optional. The [Commit Message Footer](#commit-footer) format des
``` ```
The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional. The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is optional.
Exclamation mark is optional too, but it's used to mark breaking changes.
##### Type ##### Type
@ -87,33 +90,23 @@ You can include a comparison of the previous behavior with the new behavior in o
#### <a name="commit-footer"></a>Commit Message Footer #### <a name="commit-footer"></a>Commit Message Footer
The footer can contain information about breaking changes and deprecations and is also the place to reference GitHub issues, Jira tickets, and other PRs that this commit closes or is related to. The footer is optional and is used for two purposes:
For example:
- To reference issues that this commit closes
- To include information that doesn't fit in the header or body, such as a link to a file or a suggestion to review a pull request
The format for the footer is as follows:
``` ```
BREAKING CHANGE: <breaking change summary> Closes/Fixes #<issue number>
<BLANK LINE>
<breaking change description + migration instructions>
<BLANK LINE>
<BLANK LINE>
Fixes #<issue number>
``` ```
or or
``` ```
DEPRECATED: <what is deprecated> See pull request #<pull request number>
<BLANK LINE>
<deprecation description + recommended update path>
<BLANK LINE>
<BLANK LINE>
Closes #<pr number>
``` ```
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.
Similarly, a Deprecation section should start with "DEPRECATED: " followed by a short description of what is deprecated, a blank line, and a detailed description of the deprecation that also mentions the recommended update path.
### Revert commits ### Revert commits
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.