development-review

star 179

开发规范 - 开发前规范参考 + 开发后提交前检查,必要时调用子技能进行深度验证

w7panel By w7panel schedule Updated 3/1/2026

name: development-review description: 开发规范 - 开发前规范参考 + 开发后提交前检查,必要时调用子技能进行深度验证

Development Review

开发规范技能,覆盖开发前规范参考和开发后提交前检查。

定位

阶段 内容 说明
开发前 规范参考 架构思维、接口设计、性能优化、代码质量、TDD
开发后 提交前检查 自动化检查 + verification + debugging + code-review

核心理念:开发时专注实现,开发后快速验证。


开发前:规范参考

1. 架构思维

  • 开发前分析:了解项目目录结构,确认新功能放置位置
  • 遵循现有模式:参考同类功能实现,保持一致性
  • 长期维护:避免单文件过大,采用模块化设计
  • 避免"最简单方案"陷阱:选择最合理的方案,而非最快的

2. 接口设计

  • 不破坏协议:不改变已有的接口协议标准
  • 增强而非新建:在原接口基础上增强功能
  • 接口统一:避免同一功能多套实现

3. 性能优化

  • 先分析瓶颈:用数据说话,而非猜测
  • 实测对比:优化前后性能对比,验证效果
  • 资源限制:设置合理的最大文件大小、超时等

4. 代码质量

  • 及时清理:移除调试代码、注释掉的代码
  • 无冗余:不保留备用方案代码
  • 命名规范:使用统一的命名风格

5. 文档规范

  • 必须有 README:项目根目录必须有 README 文件
  • 变更记录:代码变更应记录在 CHANGELOG

6. 备份规范

  • 重构前备份:代码重构前必须创建备份
  • 大规模变更提醒:变更 > 500 行时提醒备份

开发后:提交前检查

检查级别

快速检查(< 10秒)

跳过:编译、Lint、类型检查、冗余代码检查

适用:日常开发后快速验证

完整检查

适用:提交前、代码审查、CI/CD

宽松模式

只警告不阻止

适用:探索性开发、实验性功能


检查清单

1. 提交前检查(优先级最高)

检查项 说明
编译检查 运行构建命令
Lint 检查 运行 linter
类型检查 运行类型检查
空提交 检查是否有实际代码变更

2. 代码质量检查

检查项 说明
调试代码 console.log, print, fmt.Println 等
敏感信息 password, token, secret 等
冗余代码 TODO, FIXME, HACK 注释

3. 文档规范检查

检查项 说明
文档完整性 检测 README.md
CHANGELOG 检测变更日志

4. 备份检查

检查项 说明
大规模变更 git 变更 > 500 行提醒

整合子技能

子技能列表

文件 触发场景
verification.md 声称完成前必须验证
debugging.md 检查失败需要修复
tdd.md 开发中需要写测试
code-review.md 提交前人工审查

调用流程

开发完成 → 运行 development-review
            │
            ├── 检查失败 → debugging.md (调试)
            │                 │
            │                 └── 修复后再次检查
            │
            ├── 检查通过 → verification.md (验证证据)
            │                 │
            │                 └── 验证通过
            │
            └── code-review.md (人工审查)
                      │
                      └── 提交

退出码

说明
0 所有检查通过
1 有失败项(严格模式)
2 有警告项(宽松模式)
Install via CLI
npx skills add https://github.com/w7panel/w7panel --skill development-review
Repository Details
star Stars 179
call_split Forks 24
navigation Branch main
article Path SKILL.md
More from Creator