Skip to content

Commit

Permalink
docs(README): address README review feedback
Browse files Browse the repository at this point in the history
Signed-off-by: Eliza Weisman <[email protected]>
  • Loading branch information
hawkw committed Jul 1, 2022
1 parent c5dbc11 commit 9f78b0c
Showing 1 changed file with 5 additions and 12 deletions.
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 9f78b0c

Please sign in to comment.