Loading...

commit

Original：🇺🇸 English

Translated

Pre-commit workflow and commit guidelines. Use when asked to commit changes. Requires passing lint and tests, signed commits, semantic prefixes, imperative mood.

7installs

Sourcelgtm-hq/ai-skills

Added on2026-08-12

NPX Install

npx skill4agent add lgtm-hq/ai-skills commit

Tags

Translated version includes tags in frontmatter

git-commit pre-commit-workflow commit-guidelines semantic-commits signed-commits

SKILL.md Content

View Translation Comparison →

Commit

Pre-commit workflow and commit guidelines.

Pre-commit Checklist

Before making ANY commit:

Run the
```
lint
```
skill's workflow — all checks must pass with zero issues (abort if any issues remain). Follow the
```
lint
```
skill — full check, no
```
--tools
```
filtering.
All tests must pass (
```
uv run lintro tst
```
)
Where applicable, Docker builds pass

Commit Requirements

Every commit MUST be signed/verified

Use semantic commit prefixes:

fix:

,

feat:

,

chore:

,

docs:

,

refactor:

,

test:

,

build:

,

ci:

,

perf:

,

style:

Commit messages MUST be in imperative mood ("Add feature" not "Added feature")

Commit Granularity

Make incremental, logical commits rather than one large commit:

Group related changes (e.g., all logging for one subsystem)
Separate concerns (e.g., bug fixes vs features vs docs)
Each commit should be independently reviewable and revertable
Use judgment: 1 commit per file is too granular, 1 commit for everything is too coarse

Good groupings:

feat(logging): add subprocess execution logging

(one component)

feat(logging): add config parsing logging

(related files)

```
docs: add debugging guide
```
(documentation separate from code)

Bad groupings:

One commit with 11 files touching 4 different concerns
11 separate commits for a cohesive feature

Branch Context Awareness

When working on a new extension or feature branch where all files are new:

Every file should show as "A" (added), never "M" (modified)
If you see "M" on files that should be new, the commit history needs fixing
This indicates commits were made in the wrong order or need restructuring

When modifying an existing codebase:

"M" (modified) is expected and correct
Focus on logical grouping of related changes

Restructuring Commits

If commits are poorly structured (too large, wrong groupings, or showing modified when should be added):

Find the commit before the problematic ones:
```
git log --oneline
```
Soft reset to that point:
```
git reset --soft <good-commit>
```
Unstage all changes:
```
git reset HEAD
```
Re-add and commit in logical groups with proper messages
Verify with
```
git status
```
that file statuses (A/M) are correct

Usage

When asked to commit:

Run the
```
lint
```
skill's workflow — abort if any issues remain (follow the
```
lint
```
skill — full check, no
```
--tools
```
filtering)
- Raycast extensions: run
```
uv run lintro fmt/chk
```
  first, then
```
npm run lint
```
  per the
```
raycast
```
  skill (Raycast rules take precedence)
- Other projects without lintro: use the appropriate lint command from the
```
lint
```
  skill
Run tests - abort if any failures:
- Projects with lintro:
```
uv run lintro tst
```
- Raycast extensions: run Vitest if the extension has tests configured (
```
bun test
```
  or the extension's test script); otherwise manual smoke test via
```
bun run dev
```
  (see the
```
raycast
```
  skill)
- Other projects: use appropriate test command
- When authoring or modifying a Raycast extension, use the
```
raycast
```
  skill for toolchain-specific guidance
Check Docker if applicable
Review changes with
```
git status
```
to plan logical groupings
Stage and commit in logical groups with signed, semantic, imperative messages:
bash
```
git add <related-files>
git commit -S -m "feat: add user authentication"
```
Repeat steps 4-5 for each logical group of changes

Examples

Good commit messages:

fix: resolve null pointer in user service

```
feat: add dark mode toggle
```
```
chore: update dependencies
```
```
docs: improve API documentation
```
```
refactor: simplify authentication flow
```

Bad commit messages:

```
fixed bug
```
(not semantic, past tense)
```
WIP
```
(not descriptive)
```
updates
```
(not semantic, not specific)