commit_skill

Overview

This skill creates validated, conventional-format Git commits and enforces local safety checks before committing. It guides you through pre-commit branch validation, running the same lint/type tests as CI, reviewing diffs, and composing a conventional commit message. The goal is small, focused, and traceable commits that match project rules.

How this skill works

The skill runs a pre-commit safety check to prevent committing directly to protected branches (dev/main/master) and instructs you to create a feature branch. It then runs local validation commands (format, lint, type checks) for backend and frontend stacks, prompts you to review staged and unstaged diffs, and helps assemble a conventional commit message with issue reference and co-author metadata. It enforces rules like single logical change per commit and subject line length limits.

When to use it

• When preparing any change for version control to ensure it meets CI-quality checks locally.
• Before pushing changes that must reference an open issue (use #N format).
• When you need to produce a conventional commit message for changelogs and automation.
• For trivial fixes or typos that still require a validated, traceable commit.
• When enforcing team rules about branch protection and atomic commits.

Best practices

• Never commit directly to dev/main/master; create an issue-scoped feature branch.
• Run all local validations (format, lint, type checks) and fix failures before committing.
• Keep commits atomic: one logical change per commit and keep subject < 72 chars.
• Reference the related issue in the subject using #<number> and include Co-Authored-By when applicable.
• Use interactive staging (git add -p) to split unrelated changes into separate commits.

Example use cases

• Making a bug fix: run validations, stage the fix, and commit as fix(#123): Correct null handling.
• Adding a small feature: create feature branch, validate, then commit as feat(#456): Add user settings endpoint.
• Fixing a typo: git add . && git commit -m "fix(#789): Fix typo in error message" for a quick validated commit.
• Refactoring a module: split into multiple atomic commits and use refactor(#321): Improve auth middleware.
• Preparing production release: ensure all commits follow conventional format for automated changelog generation.