Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Denis Kasak <[email protected]>
  • Loading branch information
poljar and dkasak authored Sep 3, 2024
1 parent d5ce533 commit d58771f
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ using git-cliff, which fetches changelog entries from commit messages.

## Commit Message Format

We support the default Conventional Commits format, along with a specific git
trailer for the changelog message.
Commit messages should be formatted as Conventional Commits. In addition, some
git trailers are supported and have special meaning (see below).

### Conventional Commits

Expand All @@ -37,10 +37,10 @@ olm, cipher).

### Changelog Trailer

In addition to the conventional commit format, you can use a git trailer to
specify the changelog message explicitly. When the `Changelog` trailer is defined,
the value from the trailer will be used in the changelog instead of the commit's
first line.
In addition to the Conventional Commit format, you can use the `Changelog` git
trailer to specify the changelog message explicitly. When that trailer is
present, its value will be used as the changelog entry instead of the commit's
leading line.


#### Example Commit Message
Expand Down

0 comments on commit d58771f

Please sign in to comment.