Skip to content

README.md

Latest commit

 

History

History
106 lines (80 loc) · 5.31 KB

README.md

File metadata and controls

106 lines (80 loc) · 5.31 KB
Raw

git-commit

English | 한국어

Easily create commits that follow your project's commit rules.

Choose which changes to commit, or leave the scope unspecified to commit all current changes.
If the project has no commit rules, the skill creates atomic commits—each with a single reason for change—and uses the Conventional Commits 1.0.0 message format.

Why use it?

  • Flexible scope: 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, using the built-in guidelines only where those rules leave gaps.
  • Default commit principles: If the project has no rules for splitting commits, apply the built-in guidelines to create atomic commits.
  • Sensitive data protection: Prevent sensitive information such as API keys, tokens, credentials, and private keys from being committed.
  • Commit exclusions: Configure excluded paths so the skill never commits them.
  • No Git hook bypasses: Do not bypass configured Git hooks.
  • Limited to commits: Perform only the checks and operations needed to create commits. Do not run project quality checks such as tests, linting, or builds; push commits; 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

Usage

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

commit.

You can also limit the scope to specific files or folders, or to 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

The project's own commit rules take priority. The skill applies the default rules in references/guidelines.md only for aspects the project does not specify: how to split commits or how to format commit messages.

If the project does not specify a commit message format, the skill uses Conventional Commits 1.0.0.

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.

Use the same pattern syntax as .gitignore. Rules are applied from top to bottom, with paths relative to the project root.

For example:

.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 changes are eligible for a commit Stops without creating an empty commit
A merge, rebase, cherry-pick, or revert is in progress, or conflicts remain unresolved Stops 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 quality checks such as tests, linting, or builds
  • push commits to a remote repository
  • create or switch branches
  • create tags or pull requests

To update the remote repository, you must request a push separately.

Result format

After committing, the skill shows each commit's short ID and message on a separate line.

For example:

Commits created.

- `1ed8644` feat: add git commit skill
- `0bdfd1d` test: add git commit evaluation harness

No uncommitted changes remain.

If any changes remain uncommitted, the skill explains why. If a commit fails, it reports the step that failed and the reason.

Skill files

All skill files are based on the Korean source files listed below. The English files are AI translations of those originals. The Korean originals are authoritative for all matters of content and interpretation.