Commit graph

14 commits

Author SHA1 Message Date
Eberhard Beilharz
1becb87547
maint(resources): honor configure comment character in commit message
Git allows to specify a comment character different from the default
`#`. This is helpful when using markdown in commit messages, especially
when adding a user test section that has to start with `# User testing`
in order for the test bot to detect it.

This change modifies the `prepare-commit-msg` hook and adds a check for
a configured `core.commentString` or `core.commentChar`. If both are not
set it falls back to the default `#` character.

You can set a different comment character with
`git config core.commentChar //`.

Build-bot: skip
Test-bot: skip
2025-09-05 10:45:58 +02:00
Marc Durdin
466edc30fc chore: add cherry-pick information in commit messages
Fixes: #11702
2024-06-06 08:56:42 +07:00
Marc Durdin
222ff6a182 change(common): add extra commit message hints
These changes come out of discussion in the team; we want to make use of
git trailers and improve the quality of our commit messages. Starting by
adding more hints to the commit suggestions. Includes some minor cleanup
of the hooks, and hopefully also improves tests so that they don't
interfere with interactions with non-Keyman repos.

Note: the scopes list may need maintenance as the list still includes
sub-scopes and 'oem'.
2024-05-28 10:57:46 +07:00
Marc Durdin
3005a82a8f chore: update docs and non-standard readlink refs 2023-02-22 10:41:54 +07:00
Marc Durdin
ee52b40307 chore: exclude parens if no scope in commit msg
If no scope is found in the branch name, then don't include the
parentheses around the scope, as this breaks automatic merge messages
and the parentheses are unnecessary.
2020-10-05 13:59:32 +11:00
Marc Durdin
9c4db22219 chore(common/resources): cleanup 2020-05-20 12:27:47 +10:00
Marc Durdin
b69490ea39 fix(common/resources): allow custom commit-msg-defs 2020-05-20 12:25:58 +10:00
Marc Durdin
d64014734b chore(common/resources): update prepare-commit-msg with global scopes 2020-05-19 17:32:26 +10:00
Eberhard Beilharz
35c6208273 refactor(common): Simplify and improve getting hook directory 2020-02-20 21:44:46 +01:00
jahorton
3c4679ae6f feat(common): Proper docs, extra tweak 2020-02-06 11:01:08 +07:00
jahorton
c81729fbe0 feat(common): creates common type/scope defn script for inclusion 2020-02-06 10:56:39 +07:00
jahorton
538aa7d14b feat(common): tweaks documentation, does cleanup 2020-02-04 12:53:44 +07:00
jahorton
714198c777 feat(common): Autogenerates commit prefixes from branch name 2020-02-04 12:42:58 +07:00
jahorton
886e7d294d feat(common): basic prepare-commit-msg setup, link 2020-02-04 10:48:17 +07:00