Skip to content

README.md

Latest commit

 

History

History
108 lines (82 loc) · 5.51 KB

README.md

File metadata and controls

108 lines (82 loc) · 5.51 KB
Raw

git-commit

English | 한국어

Create commits that follow your project's commit rules with ease.

You can choose what to commit. If you do not specify a scope, the skill commits all current changes.
If the project has no commit rules, each commit contains one logical change and uses the Conventional Commits 1.0.0 message format.

Why use it?

  • Scope-aware: Commit all changes, or only specified files and folders.
  • Safe commits: Preserve changes and staging state that do not belong to the current commit.
  • Project rules first: Follow the project's own commit rules first and use the built-in guidelines only where those rules are incomplete.
  • Default commit principles: If the project has no rules for how to split commits, keep one logical change in each commit and split independent changes into separate commits.
  • Sensitive data protection: Prevent sensitive information such as API keys, tokens, credentials, and private keys from being committed.
  • Commit exclusions: Configure excluded paths to prevent the skill from committing them.
  • Git hooks run: Use the standard git commit command so configured Git hooks run as usual.
  • Limited to commits: Only inspect the repository and run Git operations needed to create commits. Do not run tests, linters, builds, whitespace checks, or other project commands, and do not push, create or switch branches, create tags, or open pull requests.

Install

To use the skill in the current project, run:

npx skills add audok/git-commit

To use it in every project, add the -g option:

npx skills add audok/git-commit -g

Usage

Invoke the skill manually or ask the agent to commit. If you do not specify a scope, it commits all current changes.

commit

You can also specify a scope, such as a particular file or folder, or only the changes already selected for a commit (staged changes).

Commit only the changes in src/auth.py.

Use the git-commit skill to commit only the staged changes.

Commit policy

If the project has its own commit rules, those rules take priority. The skill applies the default rules in references/guidelines.md only when the project does not specify how to split commits or format commit messages.

Commit messages use the Conventional Commits 1.0.0 format.

The skill does not commit sensitive information such as API keys, tokens, credentials, or private keys.

Exclude paths

Add any files or folders the skill must never commit to the installed skill's references/exclusions.md. This file is empty by default.

Write the patterns in the same way as .gitignore. Each rule is applied from top to bottom relative to the project root.

.env*
local-scratch/*
!local-scratch/example.env

This example excludes files whose names begin with .env and files in the local-scratch folder, but allows local-scratch/example.env again.

Exclusion rules always apply, even if a file is staged or the user explicitly asks to commit it.

Safety behavior

Situation Behavior
No committable changes remain Stops without creating an empty commit
A merge, rebase, cherry-pick, or revert is in progress, or conflicts remain unresolved Stops the commit and reports the current project state
A file or folder is outside the requested scope Leaves its changes and staging state unchanged
A file or folder matches an exclusion rule Does not commit it, even if it is staged or explicitly requested
Sensitive information is found Does not commit the changes containing it
A Git hook rejects the commit Stops without retrying or bypassing the check and preserves any commits already created

The skill does not bypass checks with --no-verify, modify existing commits with --amend, or change Git configuration.

Deliberate boundaries

This skill only creates local commits in the current project. It does not automatically:

  • run project commands such as tests, linters, builds, or whitespace checks
  • push commits to a remote repository
  • create or switch branches
  • create tags or pull requests

To update a remote repository, push separately after the commit is complete.

Result format

When the commit is complete, the skill shows each commit's short ID and message on its own line.

Created two local commits:

- `8e3cb15` feat: add git commit skill
- `038340e` test: add git commit evaluation harness

Working tree is clean.

If any changes are left uncommitted, the skill also explains why. If a commit fails, it explains where and why it failed.

Skill files

All skill files are based on the Korean source files listed below. The English files are AI translations of those Korean originals, and the Korean originals govern all questions of content and interpretation.