infra-rebuild/CONTRIBUTING.md
June 11a2b74aee
docs: redefine commit message "update" tag to be for tagging non-feat.
Redefine the commit message "update" tag to be for tagging an
enhancement or update, which doesn't qualify as a feature, and also have
it not be restricted from tagging a breaking change.
2024-06-06 21:04:48 +02:00

1.2 KiB

Contributing

Commit Message Format

The commit message format is as follows:

tag(!): short description

Longer description here if necessary

The tag should be one of the following:

  • fix - for a bug fix
  • update - for an enhancement or update not qualifying as a feature
  • feature - for a new feature
  • perf - for a code change that improves performance
  • refactor - for a code change that isn't one of fix, update, feature or perf
  • build - for changes that affect the build system or external dependencies
  • test - for adding or correcting tests
  • style - for changes to the linter or formatter configuration and its results
  • docs - for changes to documentation only
  • other - for anything that isn't covered by the tags above

If a change is a breaking change then that should be indicated by adding a ! after the tag.

These tags are an adapted version of the tags eslint and of the tags Angular use.
This commit message format is also inspired by Conventional Commits.