git-commit
npx machina-cli add skill theinterneti/TTA.dev/git-commit --openclawFiles (1)
SKILL.md
1.2 KB
Git Commit Standards (TTA.dev)
All commits must follow Conventional Commits.
Commit Format
<type>: <short description>
Types:
| Type | When to Use |
|---|---|
feat: | New feature or capability |
fix: | Bug fix |
docs: | Documentation only |
refactor: | Code restructuring (no behavior change) |
test: | Adding or updating tests |
chore: | Maintenance, CI, dependencies |
Before Every Commit
Run the quality gate (see build-test-verify skill):
uv run ruff format .
uv run ruff check . --fix
uvx pyright platform/
uv run pytest -v --tb=short -m "not integration and not slow and not external"
Rules
- Keep commits atomic — one logical change per commit.
- Write descriptions in imperative mood ("add feature" not "added feature").
- Reference issue numbers when applicable.
Deep Reference
For full quality gate details, see docs/agent-guides/testing-architecture.md.
Source
git clone https://github.com/theinterneti/TTA.dev/blob/main/.claude/skills/git-commit/SKILL.mdView on GitHub Overview
This skill enforces Conventional Commits in the TTA.dev repository and runs a pre-commit quality gate before every commit. It defines commit types (feat, fix, docs, refactor, test, chore) and ensures atomic changes with quality checks.
How This Skill Works
You commit using the format <type>: <short description>. Before you commit, run the quality gate commands (ruff format, ruff check, Pyright, and pytest with selective tests) to ensure code quality and test pass before history gets updated.
When to Use It
- When adding a new feature or capability (feat:)
- When fixing a bug (fix:)
- When updating documentation (docs:)
- When performing a code refactor with no behavioral changes (refactor:)
- When adding or updating tests or performing maintenance (test: / chore:)
Quick Start
- Step 1: Run the quality gate: uv run ruff format ., uv run ruff check . --fix, uvx pyright platform/, uv run pytest -v --tb=short -m \"not integration and not slow and not external\"
- Step 2: Create a commit with the proper format (e.g., feat: add feature) following Conventional Commits.
- Step 3: Push your changes to the repository.
Best Practices
- Keep commits atomic: one logical change per commit.
- Write descriptions in imperative mood.
- Use the appropriate Conventional Commits type (feat, fix, docs, refactor, test, chore).
- Reference issue numbers when applicable.
- Run the pre-commit quality gate before committing (see build-test-verify steps).
Example Use Cases
- feat: add user authentication flow
- fix: resolve null pointer in login flow
- docs: update API usage notes for v2
- refactor: simplify data loader without changing behavior
- test: add unit tests for login edge cases
Frequently Asked Questions
Add this skill to your agents