-
-
Notifications
You must be signed in to change notification settings - Fork 210
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): address README review feedback
Signed-off-by: Eliza Weisman <[email protected]>
- Loading branch information
Showing
1 changed file
with
5 additions
and
12 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -693,28 +693,21 @@ following context is generated to use for templating: | |
|
||
##### Footers | ||
|
||
A conventional commit's body may end with any number of structured key-value | ||
pairs known as [_footers_]. These consist of a string token naming the footer, a | ||
separator (which is either `: ` or ` #`), and a value, similar to [the git | ||
trailers convention][trailers]. For example: | ||
A conventional commit's body may end with any number of structured key-value pairs known as [_footers_](https://www.conventionalcommits.org/en/v1.0.0/#specification). These consist of a string token naming the footer, a separator (which is either `: ` or ` #`), and a value, similar to [the git trailers convention](https://git-scm.com/docs/git-interpret-trailers). | ||
|
||
For example: | ||
|
||
- `Signed-off-by: User Name <[email protected]>` | ||
- `Reviewed-by: User Name <[email protected]>` | ||
- `Fixes #1234` | ||
- `BREAKING CHANGE: breaking change description` | ||
|
||
When a conventional commit contains footers, the footers are passed to the | ||
template in a `footers` array in the commit object. Each footer is represented | ||
by an object with the following fields: | ||
When a conventional commit contains footers, the footers are passed to the template in a `footers` array in the commit object. Each footer is represented by an object with the following fields: | ||
|
||
- `"token"`, the name of the footer (preceeding the separator character) | ||
- `separator`, the footer's separator string (either `: ` or ` #`) | ||
- `value`, the value following the separator character | ||
- `breaking`, which is `true` if this is a `BREAKING CHANGE:` footer, and | ||
`false` otherwise | ||
|
||
[_footers_]: https://www.conventionalcommits.org/en/v1.0.0/#specification | ||
[trailers]: https://git-scm.com/docs/git-interpret-trailers) | ||
- `breaking`, which is `true` if this is a `BREAKING CHANGE:` footer, and `false` otherwise | ||
|
||
##### Breaking Changes | ||
|
||
|