拉取请求审查清单
一个审阅者清单,可以捕捉人们实际上错过的事情。将其粘贴到您的 PR 描述模板中或将其用作个人审核提示。
下载.md
# 公关审查清单 在单击“批准”之前浏览此列表。如果有任何未选中的内容,请发表评论。 ## 适用范围 - [ ] 公关只做一件事;标题用一行描述了那件事 - [ ] 没有将路过式重构与变更混合在一起 - [ ] Diff 适合您的头脑(< 400 行,或拆分) ## 正确性 - [ ] 满足链接工单的接受标准 - [ ] 处理的边缘情况:空输入、最大输入、并发调用、网络故障 - [ ] 排除了相差一和时区错误 - [ ] 错误路径返回有用的错误,而不是无声的失败 ## 测试 - [ ] 新代码有测试;每个验收标准至少有一个 - [ ] 测试断言行为,而不是实现 - [ ] 如果代码回归,测试实际上会失败 - [ ] 否 `skip`, `xit`, `it.only`,或注释掉的断言 ## 可读性 - [ ] 名称描述意图,而不是类型或位置 - [ ] 评论解释的是“为什么”,而不是“什么” - [ ] 没有神奇的数字,没有复制粘贴的块 - [ ] 记录了公共 API ## 安全性 - [ ] 用户输入在边界处验证 - [ ] 代码或测试中没有秘密/令牌/密钥 - [ ] 授权检查,而不仅仅是身份验证 - [ ] 没有新的 SQL 注入/XSS/SSRF 表面 ## 性能 - [ ] 排除了 N+1 个查询(计算测试中的查询) - [ ] 没有无限循环或无限结果集 - [ ] 为新查询模式添加索引 - [ ] 后台繁重工作,不在请求周期中 ## 运营 - [ ] 迁移是可逆的(或明确只向前) - [ ] 添加了针对危险更改的功能标记 - [ ] 为新流添加的日志/指标 - [ ] 如果行为发生变化,则更新操作手册/文档 ## 批准/请求更改 - **批准** 如果每个框都被选中 - **请求更改** 如果有任何拦截器未被选中 - **评论** 如果您有建议但没有阻碍 --- 完成词汇表的定义: https://sprintflint.com/glossary/definition-of-done
# 公关审查清单
在单击“批准”之前浏览此列表。如果有任何未选中的内容,请发表评论。
## 适用范围
- [ ] 公关只做一件事;标题用一行描述了那件事
- [ ] 没有将路过式重构与变更混合在一起
- [ ] Diff 适合您的头脑(< 400 行,或拆分)
## 正确性
- [ ] 满足链接工单的接受标准
- [ ] 处理的边缘情况:空输入、最大输入、并发调用、网络故障
- [ ] 排除了相差一和时区错误
- [ ] 错误路径返回有用的错误,而不是无声的失败
## 测试
- [ ] 新代码有测试;每个验收标准至少有一个
- [ ] 测试断言行为,而不是实现
- [ ] 如果代码回归,测试实际上会失败
- [ ] 否 `skip`, `xit`, `it.only`,或注释掉的断言
## 可读性
- [ ] 名称描述意图,而不是类型或位置
- [ ] 评论解释的是“为什么”,而不是“什么”
- [ ] 没有神奇的数字,没有复制粘贴的块
- [ ] 记录了公共 API
## 安全性
- [ ] 用户输入在边界处验证
- [ ] 代码或测试中没有秘密/令牌/密钥
- [ ] 授权检查,而不仅仅是身份验证
- [ ] 没有新的 SQL 注入/XSS/SSRF 表面
## 性能
- [ ] 排除了 N+1 个查询(计算测试中的查询)
- [ ] 没有无限循环或无限结果集
- [ ] 为新查询模式添加索引
- [ ] 后台繁重工作,不在请求周期中
## 运营
- [ ] 迁移是可逆的(或明确只向前)
- [ ] 添加了针对危险更改的功能标记
- [ ] 为新流添加的日志/指标
- [ ] 如果行为发生变化,则更新操作手册/文档
## 批准/请求更改
- **批准** 如果每个框都被选中
- **请求更改** 如果有任何拦截器未被选中
- **评论** 如果您有建议但没有阻碍
---
完成词汇表的定义: https://sprintflint.com/glossary/definition-of-done
停止填写模板。
SprintFlint 为您运行冲刺(容量、速率、回顾、燃尽),无需模板来保持最新。