conventional-committer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Conventional Committer Skill (规范提交技能)

Conventional Committer Skill

能力 (Capabilities)

Capabilities

  • 暂存 (Staging): 将修改后的文件添加到 git 暂存区。
  • 消息生成: 创建遵循
    type(scope): description
    格式的提交消息 (例如:
    feat(auth): add login page
    )。
  • 提交 (Committing): 执行
    git commit
  • Staging: Add modified files to the git staging area.
  • Message Generation: Create commit messages that follow the
    type(scope): description
    format (e.g.,
    feat(auth): add login page
    ).
  • Committing: Execute
    git commit
    .

指令 (Instructions)

Instructions

  1. 规范对齐: 在提交前必须确认遵循 开发规范 - 提交规模与原子化改动
  2. 规模校验: 强制检查本次改动的文件数量。原则上文件数 不要超过 10 个;对应的功能点必须单一。
  3. 任务关联: 每次提交应且仅应关联 待办事项 (Todo) 中的一个原子条目。
  4. 提交前检查: 在执行任何 git 提交操作前,确认
    @code-auditor
    已经通过了
    pnpm typecheck
    ,
    pnpm lint
    和必要的定向测试
  5. 验证状态: 检查
    git status
    查看哪些内容需要暂存。
  6. 生成消息: 分析更改以确定
    type
    (feat, fix, docs, style, refactor, test, perf, build, ci, chore, revert),
    scope
    (可选, 例如: 组件名, 模块) 和
    description
    。消息描述统一使用中文
  7. 提交: 运行
    git commit -m "..."
  8. 验证: 确保消息符合
    commitlint.config.ts
  1. Specification Alignment: Before committing, confirm compliance with Development Standards - Commit Scale & Atomic Changes.
  2. Scale Check: Mandatorily check the number of files changed. In principle, the number of files should not exceed 10; the corresponding feature point must be single-purpose.
  3. Task Association: Each commit should be associated with exactly one atomic item in Todo.
  4. Pre-commit Check: Before performing any git commit operation, confirm that
    @code-auditor
    has passed
    pnpm typecheck
    ,
    pnpm lint
    and necessary targeted tests.
  5. Status Verification: Check
    git status
    to see which content needs to be staged.
  6. Message Generation: Analyze the changes to determine the
    type
    (feat, fix, docs, style, refactor, test, perf, build, ci, chore, revert),
    scope
    (optional, e.g., component name, module) and
    description
    . The message description must use Chinese uniformly.
  7. Commit: Run
    git commit -m "..."
    .
  8. Verification: Ensure the message complies with
    commitlint.config.ts
    .

使用示例 (Usage Example)

Usage Example

输入: "提交新的用户资料功能。" 动作:
git add .
, 分析变更, 生成消息
feat(user): 实现带有头像上传功能的用户个人资料页面
,
git commit
Input: "Commit the new user profile feature." Action:
git add .
, analyze changes, generate message
feat(user): Implement user profile page with avatar upload functionality
,
git commit
.