diff --git a/skills/formatting-commits/SKILL.md b/skills/formatting-commits/SKILL.md index bd616b57822728cb694c15b1687ed7ad5869d251..0fb74cd754043f660900c5786f32889df6545d45 100644 --- a/skills/formatting-commits/SKILL.md +++ b/skills/formatting-commits/SKILL.md @@ -14,7 +14,7 @@ Create commits using `git formatted-commit`. For amends, choose the appropriate `git formatted-commit` has no sub-commands and the following options: - + -t --type Commit type (required) -s --scope Commit scope (optional) -B --breaking Mark as breaking change (optional) @@ -24,8 +24,8 @@ Create commits using `git formatted-commit`. For amends, choose the appropriate -a --add Stage all modified files before committing (optional) --amend Amend the previous commit (optional) -h --help - - + + git formatted-commit -t feat -s "web/git-bug" -m "do a fancy new thing" -b "$(cat <<'EOF' Multi-line @@ -34,7 +34,7 @@ Multi-line EOF )" -T "Fixes: https://todo.sr.ht/~user/tracker/#123" - + Most source code repositories require both an appropriate prefix _and_ scope. Necessity of scope increases with repository size; the smaller the repo, the less necessary the scope. Valid trailers for ticket tracking integration depend on the platform in use.