Conventional Commits

Created: 2020-09-04T07:25:28+00:00

This card pertains to a resource available on the internet.

Format

type: description
type!: description
type(scope): description
type(scope)!: description

Sometimes might be footers as well.

refactor!: break shit

BREAKING CHANGE: shit has become broken

Versioning w/ SemVer

fix: tags increase patch version
feat: tags increase minor version
change!: tag with ! means brakage so increase major version

It's implied you should increment each time this happens but I would say pick the largest component to bump and zero the ones below it. Also do this when it makes sense and not all the time. It would be extremely derpy to have two breaking changes that get rolled out as two major version bumps just because you were incrementing the version on an auto script.

Changelogs

When releasing a new version, scan commit headers for types and descriptions. So lines that are "feat: upgrade the toasters" would be grouped under "Features: - upgrade the toasters."