用途
code-review-mitsuhiko 是一个代码审查技能,用于审查代码的 API 形态、错误处理、向后兼容性,以及产品与库的适配度。它适用于审查公共 API、库接口、错误类型等场景。
其核心思路是:在开始审查前,先判断被审查的代码是产品代码、库代码,还是两者混合。因为正确的审查标准会随这个判断而变化。
主要能力
产品视角
- 这个改动现在是否解决了真实的用户问题?
- 能否先发布一个简单可用的版本,更快地验证需求?
- 这里的抽象、依赖或扩展点,是否有第二个真实用例来支撑?
- 如果接受了技术债,是否有具体的重构触发条件?
需要标记的问题包括:投机性的灵活性、不可见的优雅、非瓶颈处的优化,以及为一个功能引入的通用框架。
库视角
- 这个 API 在多年后是否仍然合理?
- 是否会破坏现有用户?如果是,需要指出版本管理和迁移成本。
- 用户能否在不 fork 的情况下扩展行为?
- 错误、默认值和扩展点是否被当作稳定的公共 API 来对待?
需要标记的问题包括:为微小改进引入破坏性变更、基于字符串匹配的错误、未文档化的扩展契约,以及“直接 fork 吧”式的设计。
跨领域检查
- 错误:是否足够类型化/结构化,便于调用方使用和生产环境诊断?
- 依赖:是否值得引入其传递依赖树,还是可以用 20-50 行清晰代码实现?
- 默认值:是否安全、符合预期,并且对成本诚实?
- 产品/库错配:库的标准是否拖慢了产品,或者产品的习惯是否让库变得不稳定?
使用方式
- 声明上下文:产品 / 库 / 混合。
- 套用对应的视角,然后执行跨领域检查。
- 先产出发现的问题,按严重程度排序。
输出约定
- 先列发现的问题:必须修复、考虑、开放问题;空的部分省略。
- 每条发现包含 [文件:行号]、与上下文相关的原因,以及具体的下一步。
- 在发现之后附上简要总结。除非被要求,否则不要添加赞美。
完整理念和措辞模式参见 PRINCIPLES.md。
适用场景
适用于审查公共 API、库接口、错误类型,以及需要区分产品代码与库代码标准的代码审查任务。
限制
资料未提供该技能的具体安装方式、运行环境、支持的平台或收费信息。