commit-convention
Commit Convention
该 Skill 不直接执行 git commit 或 git add 操作,而是为当前 Agent 提供提交信息的决策指导和格式标准。
核心策略
1. 风格学习(优先)
在生成提交信息前,必须先观察项目已有的提交习惯:
- 执行
git log -n 5 --oneline。 - 匹配历史:如果项目习惯使用特定的前缀(如
[FEAT]、Update:等)或语言习惯,应优先模仿并保持一致。 - 语言一致性:如果历史记录全是中文,则使用中文描述;如果全是英文,则使用英文。
2. 规范回退(Fallback)
如果项目提交记录为空、无明显规律,或项目明确要求使用规范化提交,请遵循 Conventional Commits 规范:
<type>(<scope>): <subject>
<body>
<footer>
Type 类型定义
feat: 新功能fix: 修补 bugdocs: 文档变更style: 不影响代码含义的变更(空白、格式、缺少分号等)refactor: 重构(既不是修复 bug 也不是添加特征的代码更改)perf: 改进性能test: 添加缺失测试或更正现有测试build: 影响构建系统或外部依赖项的更改ci: 更改 CI 配置文件和脚本chore: 其他不修改 src 或测试文件的更改revert: 回退之前的提交
Subject 格式
- 使用祈使句(如 "add" 而不是 "added")。
- 结尾不加句号。
- 首字母小写(除非是专有名词)。
- 长度控制在 50 字符以内。
操作指令 (仅供 Agent 参考)
当 Agent 需要生成提交信息时,应按以下逻辑思考:
- 观察:使用
git log -n 5 --oneline观察项目风格。 - 判断:
- 发现既定规律?→ 模仿该规律。
- 发现 Conventional Commits 模式?→ 遵循本规范。
- 初始提交/无规律?→ 采用 Conventional Commits。
- 撰写:
- 简洁的 Subject。
- 必要时提供 Body(解释 Why 而不是 How)。
- 关联 Issue(如
Closes #123)。
注意事项
- 严禁过度设计:不要生成过于复杂的提交信息,除非变更确实复杂。
- 原子性:建议一个提交只做一件事。如果发现变更过多,建议提示用户拆分提交。
- 禁止执行命令:本 Skill 仅提供“信息建议”,执行操作由主 Agent 决定。
More from ab300819/skills
work-report
生成周报、月报、季度报和年终总结。当用户提到"周报"、"月报"、"季报"、"季度报"、"年终总结"、"年度总结"、"weekly report"、"monthly report"、"quarterly report"、"annual summary"、"yearly review",或者需要生成各类工作报告时使用此 Skill。
82devdocs-test-cases
Design test cases (UT/IT/E2E) based on requirements, establishing traceability from acceptance criteria to test cases. Use when users need test case design, testing strategy, test coverage planning, or QA planning. Triggers on "test cases", "test design", "unit test", "integration test", "e2e test", "测试用例", "测试设计", "测试策略", "测试覆盖", "QA". NOT for running tests (use devdocs-test-run) or development workflow (use devdocs-dev-workflow).
42devdocs-dev-tasks
Break down system design into executable, trackable development tasks with dependency resolution and layer classification (🔴🟡🟢⚪). Use when users need task breakdown, sprint planning, or implementation planning. Triggers on "dev tasks", "task breakdown", "sprint planning", "implementation tasks", "拆分任务", "任务列表", "implementation plan", "开发任务拆分". NOT for executing tasks (use devdocs-dev-workflow) or defining features (use devdocs-feature).
38devdocs-onboard
Generate project context summary for AI tool handover. Supports --read (view only) and --update (rescan) modes. Use when switching AI tools, starting new sessions, or onboarding team members. Triggers on "project context", "handover", "onboard", "项目上下文", "交接", "接手项目", "新会话", "new session", "项目概览". NOT for retrofitting projects (use devdocs-retrofit) or requirements definition (use devdocs-requirements).
37devdocs-requirements
Expand user requirements into detailed DevDocs documents with features (F-XXX), user stories (US-XXX), and acceptance criteria (AC-XXX). Supports initial, incremental, and context (--context) modes. Use when users provide feature requirements, want to clarify scope, or add project background. Triggers on "requirements", "PRD", "feature request", "user story", "需求", "功能点", "验收标准", "项目背景", "补充信息". NOT for system/technical design (use devdocs-system-design) or test case design (use devdocs-test-cases).
36code-quality
Opinionated constraints for writing maintainable, testable code. Apply MTE principles, avoid over-engineering, guide refactoring, and provide code review checklists. Use when users write code, refactor, or need code review. Triggers on keywords like "code quality", "refactor", "review", "MTE", "代码质量", "重构", "审查".
35