关于 git-workflow
一项规范 Git 协作方式的技能，涵盖提交、分支、Pull Request、代码审查和 AI 辅助编码实践，适用于需要统一仓库工作流程的开发团队。
主要功能
- 01Conventional Commits 提交规范
- 02暂存前检查变更
- 03功能分支命名模式
- 04Pull Request 内容要求
- 05代码审查与 AI 编码规则
适用场景
- 01准备提交代码变更
- 02创建功能或修复分支
- 03按要求填写 Pull Request
- 04审查 AI 生成代码或合约升级
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/git-workflow确认已加载。
详细介绍
Git 协作规范
语言规则
- 始终使用用户所用的语言回复。 如果用户用中文提问，就用中文回复；如果用英语提问，就用英语回复。
提交规则
使用 Conventional Commits 格式：<type>: <short description>
| 类型 | 使用时机 |
|---|---|
feat: | 新功能或合约 |
fix: | 修复 Bug |
refactor: | 重构代码，但不改变行为 |
test: | 添加或更新测试 |
docs: | 文档变更 |
chore: | 构建配置、依赖更新、工具链 |
security: | 安全修复或加固 |
提交流程
- 暂存前运行
git diff，检查所有变更 - 暂存指定文件——避免使用
git add .，以免提交.env或构建产物 - 编写简洁的提交信息，说明原因，而非内容
- 绝不添加
Co-Authored-By行——提交信息只能包含描述 - 只提交——除非明确要求，否则绝不运行
git push - 绝不直接推送到 main/master——始终使用功能分支
分支命名
| 模式 | 示例 |
|---|---|
feat/<name> | feat/staking-pool |
fix/<name> | fix/reentrancy-guard |
refactor/<name> | refactor/token-structure |
PR 要求
每个 PR 必须包含：
| 部分 | 内容 |
|---|---|
| 变更说明 | 变更内容及原因 |
| 测试结果 | forge test 输出（全部通过） |
| Gas 影响 | 变更函数的 forge test --gas-report 差异 |
| 部署影响 | 是否影响已部署的合约？是否需要迁移？ |
| 审查重点 | 需要仔细审查的具体方面 |
代码审查规则
| 场景 | 要求 |
|---|---|
| 常规变更 | 至少 1 位维护者批准 |
| 安全相关变更 | 至少 2 位维护者批准 |
| AI 生成的代码 | 合并前必须通过人工审查和 forge test |
| 合约升级 | 需要全体团队审查，并在分叉环境上进行升级模拟 |
AI 辅助规则
- AI 生成的代码在提交前必须通过
forge test - 始终检查 AI 输出中的导入路径是否正确、访问控制是否恰当，以及 Gas 影响
- 在 AI 提示词中加入相关文件路径和测试用例，以获得更好的结果
- AI 生成代码后运行
forge fmt，确保格式一致
评论
支持 Markdown