commit

Files (2)

• EXAMPLES.md
• SKILL.md

SKILL.md (first lines)

# Commit

## Quick start

Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).

## Definitions

- **summary**

  Short summary below 50 chars.

- **Description**

  Detailed description — what changed and why. Wrap at ~72 chars.

  Include:
  - Key decisions made
  - Blockers or notes for next iteration.

### Template

```
<type>(<scope>): <summary>

<description>

Testing:
- <what was tested>
- <how to reproduce>

References: # include only if any references exist

BREAKING CHANGE: <oneline description of breaking change> # include only if any breaking changes exist
```

Trailers (Related / QA) come after the body, each on its own line.
`BREAKING CHANGE:` is always the very last line of the commit message.

## Workflows

1. Choose a commit type: feat, fix, docs, style, refactor, perf, test, chore.
2. Add a scope when it helps locate the change (e.g., parser, api, ui).
3. Write a short, imperative subject (<=50 chars).
4. Leave a blank line, then add a concise but detailed body explaining
   motivation and notes for reviewers.
5. Add a Testing section describing verification steps.
6. If a tracking issue exists, add `Related #<issue-number>`.
7. If a QA issue was created for validation, add `QA: #<qa-issue-number>`.
8. If this commit introduces a breaking change, add a `BREAKING CHANGE:` line
   last, after every trailer, describing the change and its impact.

## Advanced notes

- Use the subject to summarize the user-visible change.
- Keep technical details in the body; include links to docs if needed.
- Trailers are parsed by automation (CI/release notes); keep exact form:
  `Related #12`, `QA: #45`.
- For examples, see `EXAMPLES.md` in this skill directory.

## References

- [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)

From tregusti/skills, MIT.

More from tregusti/skills