@@ -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:
-<git-formatted-commit-flags>
+<git_formatted-commit_flags>
-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-flags>-<git-formatted-commit-example>
+</git_formatted-commit_flags>
+<git_formatted-commit_example>
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"
-</git-formatted-commit-example>
+</git_formatted-commit_example>
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.