AgentSkillsCN

Git commit

在基于 Git 的版本控制中，遵循一套规范化的提交规则。

SKILL.md
--- frontmatter
name: Git commit
description: Set of rules to follow when committing changes in a git based
project.

Git commit

This skills will help you produce well organized and helpfull git commit.

When to use the skill

Use this skill whenever committing changes to any git based project.

Content of a commit

A commit should contain a coherent set of code modifications (change). It should be possible to sum up the commit in a few sentences. Commit message should not reference immediate commit changes otherwise, it means that those commit could be merged into one. Conversely, you should not have to resume a commit with multiple paragraph of too long a text. It probably means that the commit can be split into smaller one.

When to commit

Committing to a project should be done only when ALL of the following are true:

  1. •

    The task is fully complete. Do not commit intermediate progress. A task is not done until the user is satisfied with the result. If the user provides corrections, refinements, or follow-up instructions on the same topic, it is still the same task — not a new one. Only commit once the task has converged to a final state.

  2. •

    Tests pass and project rules are satisfied. All tests associated with the changes must pass. All project-specific rules (code linting, formatting, etc.) must be satisfied.

  3. •

    The user has reviewed the changes. Always let the user review before committing. Wait for explicit approval or for the user to move on to an unrelated task. A follow-up message that refines, corrects, or continues the current work is NOT a new task and does NOT constitute implicit approval to commit the previous state.

Commit message.

Follow the common good practices for commit messages.

Make sure to document design trade-offs or remaining tasks associated with the change in the commit message if applicable.

Rules to follow

  • •

    Never push. Let the use handle pushing or retrieving changes from a git remote.

  • •

    Never rewrite history on already pushed changes unless explicitely asked. Amending local commit is acceptable.

  • •

    If the project contains a README.md, AGENTS.md or a DESIGN.md, make sure that the files are still up to date following the change you are about to commit. If not, update them and include them in the commit.