feat: add a commit message template

Change-Id: Iea66080cc9f7f49bbaac42ca0eb51de5dfc4bcdc
This commit is contained in:
sudoforge 2024-07-18 21:02:18 -07:00 committed by sudoforge
parent bf753031d0
commit 825eecefa1
2 changed files with 38 additions and 0 deletions

33
.gitmessage Normal file
View File

@ -0,0 +1,33 @@
################################################################################
# COMMIT MESSAGE FORMAT
#
# ```
# <type>: <subject>
# <BLANK LINE>
# [body]
# <BLANK LINE>
# [footer]
# ```
#
# General notes:
# - The `type` MUST be present.
#
# - The `body` MAY be present, and should include verbose, detailed information
# about what the old behavior was, why the change was necessary, and what the
# new behavior is
#
# - The `footer` MAY be prsent, and should include any relevant trailers and
# other metadata
#
# Valid values for <type>:
# - deprecation: a change related to deprecation of a reosurce or interface
# - design: a change related to design that does not change an interface or
# any application/business logic
# - doc: a change related to documentation
# - feat: changes that introduce new behavior or a new feature
# - fix: Changes that fix an issue
# - refactor: Changes which neither fix an issue or add a feature
# - style: Changes to formatting, blank space, alignment, etc.
# - test: Changes which add missing tests or correct existing tests
################################################################################

View File

@ -28,6 +28,11 @@
nixfmt-rfc-style
nodePackages.prettier
];
shellHook = ''
# Use //:.gitmessage as the commit message template
${pkgs.git}/bin/git config --local commit.template ".gitmessage"
'';
};
}
);