conventional-committer
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseConventional 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 format (e.g.,
type(scope): description).feat(auth): add login page - Committing: Execute .
git commit
指令 (Instructions)
Instructions
- 规范对齐: 在提交前必须确认遵循 开发规范 - 提交规模与原子化改动。
- 规模校验: 强制检查本次改动的文件数量。原则上文件数 不要超过 10 个;对应的功能点必须单一。
- 任务关联: 每次提交应且仅应关联 待办事项 (Todo) 中的一个原子条目。
- 提交前检查: 在执行任何 git 提交操作前,确认 已经通过了
@code-auditor,pnpm typecheck和必要的定向测试。pnpm lint - 验证状态: 检查 查看哪些内容需要暂存。
git status - 生成消息: 分析更改以确定 (feat, fix, docs, style, refactor, test, perf, build, ci, chore, revert),
type(可选, 例如: 组件名, 模块) 和scope。消息描述统一使用中文。description - 提交: 运行 。
git commit -m "..." - 验证: 确保消息符合 。
commitlint.config.ts
- Specification Alignment: Before committing, confirm compliance with Development Standards - Commit Scale & Atomic Changes.
- 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.
- Task Association: Each commit should be associated with exactly one atomic item in Todo.
- Pre-commit Check: Before performing any git commit operation, confirm that has passed
@code-auditor,pnpm typecheckand necessary targeted tests.pnpm lint - Status Verification: Check to see which content needs to be staged.
git status - Message Generation: Analyze the changes to determine the (feat, fix, docs, style, refactor, test, perf, build, ci, chore, revert),
type(optional, e.g., component name, module) andscope. The message description must use Chinese uniformly.description - Commit: Run .
git commit -m "..." - Verification: Ensure the message complies with .
commitlint.config.ts
使用示例 (Usage Example)
Usage Example
输入: "提交新的用户资料功能。"
动作: , 分析变更, 生成消息 , 。
git add .feat(user): 实现带有头像上传功能的用户个人资料页面git commitInput: "Commit the new user profile feature."
Action: , analyze changes, generate message , .
git add .feat(user): Implement user profile page with avatar upload functionalitygit commit