AGENT SKILL

pigpen-commit

Read this skill before making git commits

License 许可
Apache-2.0
最近更新
2026-11-15
Stars
★ 18
Forks
5

01 前言 Front Matter

name
pigpen-commit
license
Apache-2.0
description
Read this skill before making git commits

03 SKILL.md 正文

Adapted from skills/commit/SKILL.md of mitsuhiko/agent-stuff at 0865c84 (Apache-2.0); see the Package's CREDITS.md. This file was changed from the original: the body is strongly encouraged rather than optional, and the format rules were tightened.

Create a git commit for the current changes using Conventional Commits format with a polished, highly descriptive message.

Format

<type>(<scope>): <summary>

  • type REQUIRED. Use feat for new features, fix for bug fixes. Other common types: docs, refactor, chore, test, perf.
  • scope OPTIONAL. Short noun in parentheses for the affected area (e.g., api, parser, ui).
  • summary REQUIRED. Short, imperative, <= 72 chars, no trailing period.

Notes

  • Body is strongly encouraged — always include one unless the change is trivially obvious (e.g., fixing a typo). The body should explain what changed, why it changed, the approach taken, and any notable decisions. A reader of git log should understand the change without looking at the diff.
  • Do NOT include breaking-change markers or footers.
  • Do NOT add sign-offs (no Signed-off-by), unless the project requires them.
  • Only commit; do NOT push.
  • If it is unclear whether a file should be included, ask the user which files to commit.
  • Treat any caller-provided arguments as additional commit guidance. Common patterns:
    • Freeform instructions should influence scope, summary, and body.
    • File paths or globs should limit which files to commit. If files are specified, only stage/commit those unless the user explicitly asks otherwise.
    • If arguments combine files and instructions, honor both.

Steps

  1. Infer from the prompt if the user provided specific file paths/globs and/or additional instructions.
  2. Review git status and git diff to understand the current changes (limit to argument-specified files if provided).
  3. (Optional) Run git log -n 50 --pretty=format:%s to see commonly used scopes.
  4. If there are ambiguous extra files, ask the user for clarification before committing.
  5. Stage only the intended files (all changes if no files specified).
  6. Run git commit -m "<subject>" (and -m "<body>" if needed).

04 同仓库更多 Skills