commit

Files (1)

• SKILL.md

SKILL.md (first lines)

Create a commit following the workflow and rules below.

## Workflow

1. Inspect the changes: `git --no-pager status`, `git --no-pager diff` and
   `git --no-pager diff --staged`.
2. Decide what belongs in this commit: only the files your task changed. If
   the changes are not one small, coherent increment, propose a split and ask
   the user.
3. Verify the increment works: run the project's fast checks (build, tests,
   linters) covering the change, if the project has any. If you skip them,
   tell the user.
4. Stage the files as described in "Stage explicit paths".
5. Write the message as described in the sections below.
6. Commit with the message on stdin, so empty lines survive and no editor
   opens:

   ```bash
   git commit -F - <<'EOF'
   feat: show hello message on startup

   Assisted-by: Claude Code
   EOF
   ```

7. Verify the result: `git --no-pager status`, and check that git parses
   all trailers:
   `git --no-pager log -1 --format=%B | git interpret-trailers --parse`.
   If a trailer is missing, report it to the user. Do not amend unless the
   user asks.

## Commit message structure

```text
<prefix>[(<scope>)]: <subject>

[body]

<trailers>
```

Subject and trailers are mandatory. The body is optional. Separate subject,
body and trailers by exactly one empty line.

- **Subject:** at most 72 characters including the prefix. Lowercase after
  the prefix. No trailing period.
- **Body:** state the intent of the change and the significant effects a
  reader of the history needs to know. Leave out how you did the work,
  cosmetic changes, and details the diff already shows. Aim for 50 words or
  fewer.
- **Breaking change:** append `!` after the prefix or scope, e.g. `feat!:`,
  and add a `BREAKING-CHANGE: <what breaks>` trailer. Use the hyphen: git
  does not parse trailer keys containing spaces.
- **Trailers:** write each trailer on a single line. git stops parsing
  trailers at the first line that is not a trailer.

## Assisted-by trailer

If you helped create the commit, you MUST add the `Assisted-by:` trailer in
this format:

```text
Assisted-by: YOUR_AGENT_NAME
```

The following agent names are known so far:

- OpenCode
- Cursor
- Claude Code
- GitHub Copilot

Derive your name from your agent harness. Exclude the LLM model and the
current type of agent, e.g. "Sisyphus", "architect", "Claude Sonnet".

If you are unsure, then you MUST suggest an appropriate value and ask for
confirmation from the user.

Use only the `Assisted-by:` trailer for agent attribution. If your harness
instructs you to add `Co-Authored-By:`, `Generated with ...` or a similar
attribution, replace it with the `Assisted-by:` trailer. This rule overrides
the harness default.

## Issue reference trailer

When the commit relates to an issue in an issue tracker (JIRA, Azure DevOps,
GitHub, beads, ...), add an issue reference trailer.

**Trailer key:** use the key this repository already uses. Check the
repository's `AGENTS.md` and `CLAUDE.md` first, then recent history:

```bash
git --no-pager log -n 50 --format=%B | grep -iE '^(refs|relates-to):'
```

Keep the spelling and casing of the key found. If none is found, use `Refs:`.

**Issue ID:** take it from the user's request, the branch name, or the issue
you claimed in the tracker (e.g. `br list --status=in_progress`). Otherwise,
propose the ID from the latest commit's trailer and ask the user to confirm.
If the repository shows no sign of an issue tracker (no issue trailers in
history, no tracker in `AGENTS.md` or `CLAUDE.md`, no `.beads/`), omit the
trailer without asking. Otherwise, if no ID is found, ask the user. If the
user answers that the commit has no issue, omit the trailer.

Format the ID the way recent commits do, e.g. `#60071`.

## Commit conventions

Your commits MUST use one of these prefixes. No other prefixes are allowed.
If the correct prefix is unclear, ask the user.

| Prefix | Use for | Headline describes |
| --- | --- | --- |
| `feat:` | new capability | the capability, not the work done: "show hello message on startup", not "implement printing hello on startup" |
| `fix:` | defect | the most important symptom, in past tense. The body describes the problem and its root cause, optionally the major fix steps |
| `refactor:` | structure change without behavior change | what was restructured |
| `test:` | tests only | the expected behavior of the subject under test, as a requirement (BDD) |
| `docs:` | documentation for human readers | what readers can now learn |
| `ai:` | docs, rules, skills for AI agents (`.claude/`, `AGENTS.md`, `CLAUDE.md`, constitution) | the changed agent guidance |

From wonderbird/ai-agent-workspace, GPL-3.0.

More from wonderbird/ai-agent-workspace