1
2################################################################################
3# COMMIT MESSAGE FORMAT
4#
5# ```
6# <type>: <subject>
7# <BLANK LINE>
8# [body]
9# <BLANK LINE>
10# [footer]
11# ```
12#
13# General notes:
14# - The `type` MUST be present.
15#
16# - The `body` MAY be present, and should include verbose, detailed information
17# about what the old behavior was, why the change was necessary, and what the
18# new behavior is
19#
20# - The `footer` MAY be prsent, and should include any relevant trailers and
21# other metadata
22#
23# Valid values for <type>:
24# - deprecation: a change related to deprecation of a reosurce or interface
25# - design: a change related to design that does not change an interface or
26# any application/business logic
27# - doc: a change related to documentation
28# - feat: changes that introduce new behavior or a new feature
29# - fix: Changes that fix an issue
30# - refactor: Changes which neither fix an issue or add a feature
31# - style: Changes to formatting, blank space, alignment, etc.
32# - test: Changes which add missing tests or correct existing tests
33################################################################################