1---
 2name: formatting-commits
 3description: Creates commits strictly following Conventional Commits format. Use when committing changes, amending commits, or when the user mentions git commits, conventional commits, or commit messages.
 4compatibility: Requires `git` and `formatted-commit` CLI tools
 5license: AGPL-3.0-or-later
 6metadata:
 7  author: Amolith <amolith@secluded.site>
 8---
 9
10Create/amend commits exclusively using `formatted-commit`. It has no sub-commands and the following options:
11
12<formatted-commit_flags>
13-t --type Commit type (required)
14-s --scope Commit scope (optional)
15-B --breaking Mark as breaking change (optional)
16-m --message Commit message (required)
17-b --body Commit body (optional)
18-T --trailer Trailer in 'Sentence-case-key: value' format (optional, repeatable)
19-a --add Stage all modified files before committing (optional)
20--amend Amend the previous commit (optional)
21-h --help
22</formatted-commit_flags>
23<formatted-commit_example>
24formatted-commit -t feat -s "web/git-bug" -m "do a fancy new thing" -b "$(cat <<'EOF'
25Multi-line
26
27- Body
28- Here
29
30EOF
31)"
32</formatted-commit_example>
33
34Most 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.
35
36- GitHub
37  - Closes:
38  - Fixes:
39  - Resolves:
40  - References:
41- SourceHut
42  - Closes:
43  - Fixes:
44  - Implements:
45  - References:
46
47Refer to [installing-formatted-commit.md](references/installing-formatted-commit.md) if it's unavailable.