代码审查问题记录模板
概述
一个标准化的模板,用于在代码审查过程中记录发现的问题,确保问题描述清晰、可追踪,并包含必要的上下文信息。
关键内容
- 问题结构化:
- 模板提供标准化的格式来记录每个代码审查问题
- 包含标题、严重性等级、问题类别等关键信息字段
-
支持定位具体的文件、行号和函数/方法
- Critical(阻塞发布):阻止功能正常运行的关键缺陷
- High(合并前应修复):严重影响功能但非阻塞性问题
- Medium(尽快修复):影响较小但需改进的问题
-
Low(可选优化):代码优化建议或非关键问题
-
问题分类:
- 安全性、性能、代码质量、可维护性、测试、设计模式、文档等多种分类
- 便于统计和分析不同类型的代码问题分布
来源
- 代码审查 — 作为代码审查流程的重要组成部分