Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: prefer description over BREAKING CHANGE #45

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: prefer description over BREAKING CHANGE #45

wants to merge 1 commit into from

Commits on Aug 7, 2023

  1. fix: prefer description over BREAKING CHANGE 

    The conventional commit specification says the following about breaking
changes indicated with ! after the type and BREAKING CHANGE footers:

> If included in the type/scope prefix, breaking changes MUST be
  indicated by a ! immediately before the :. If ! is used, BREAKING
  CHANGE: MAY be omitted from the footer section, and the commit
  description SHALL be used to describe the breaking change.

This updates the commit parser to prefer the description from the
subject line over the value of the BREAKING CHANGE footer when both
describe breaking changes. This is more inline with the specification
and also allows consumers to enumerate all breaking change descriptions
in the case where the subject and footers are used to list more than one
breaking change.
    @ttd2089
    ttd2089 committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    2e4daf1 View commit details
    Browse the repository at this point in the history