Commit Message Format

The following rules are based on Conventional Commits.

Single-Line Message

<type>[(<scope>)][!]: <summary>

<type>
- type of commit (see below)
(<scope>) (optional)
- scope of changes, wrapped in parentheses
- Do not leave parentheses empty!
exclamation point ("!") (optional)
- indicates a breaking change (semver MAJOR)
colon (":")
single space (" ")
<summary>
- description of changes

Expands on Single-Line message rules with the addition of an optional <body> and <footers>.

<type>[(<scope>)][!]: <summary>

[<body>]

[<footers>]

If the commit includes breaking changes, add the "!" to the header in addition to providing a BREAKING CHANGE footer to add more details about the breaking changes.

build
- update/modify build system and/or dependencies
chore
- any change that does not fit into any other type
docs
- changes to documentation content
feat (semver MINOR)
- add new functionality
fix (semver PATCH)
- patch bug/error
perf
- code changes that improve performance of consumed assets
publish
- Do not use!
- Reserved for build processes.
refactor
- code changes that neither fix a bug nor add a feature
saas
- changes to SAAS (Software as a Service) configurations
style
- code changes that do not modify algorithms
- e.g., white space changes, linting corrections, etc.
test
- add missing tests or update existing tests

Use imperative, present tense
- e.g., "change" instead of "changed" or "changes"
do not capitalize first letter
do not end with period

The footer is optional. Use the footer to record any of the following:

chore: deprecate hx-thingamabob

DEPRECATED: `<hx-thingamabob>`, use `<hx-thingamajig>` instead

chore!: remove hx-thingamabob

BREAKING CHANGE: Remove deprecated `<hx-thingamabob>`

fix: issue 5678

Fixes #5678

feat: add requested feature

Closes #1234

build: update dependencies

Closes JIRA-910