information about a conventional commit

interface ConventionalCommit {
    breaking: boolean;
    scope?: string;
    subject: string;
    type: string;
}

Properties

breaking: boolean

whether the commit is marked as breaking with an exclamation mark

scope?: string

scope of the commit (i.e. "scope" in feat(scope): subject)

subject: string

subject of the commit

type: string

type of the commit (e.g. feat, fix, etc)