如何为审阅者总结拉取请求
拉取请求摘要帮助审阅者理解问题、处理方式和需要关注的部分。当描述反映实际提供的变更时,它最有用。
从合适的材料开始。
- 你需要提供什么
- 页面上已展开的文本差异和可见问题上下文。
- 预期结果
- 保存摘要,涵盖观察到的变更、变更动机以及证据中实际展示的测试。
工作流程如何运作。
解释改了什么以及原因,再指出差异和笔记支持的行为、兼容性或迁移问题。将已执行测试与仅建议执行的测试分开。
结果中需要检查的内容。
发布前将摘要与改动文件比较。除非提供的证据能够证明,否则不要声称测试已通过或风险已消除。
预览 Markdown,检查标题、列表、链接及文字。将来源引用与文档一起保留,以便审阅者追溯重要陈述对应的原始材料。
参考完整示例学习。
可下载的 Markdown 示例展示一种结果组织方式。结合来源示例阅读,区分哪些是已记录事实、建议措辞,以及仍待回答的问题。
所提供的示例仅用于说明,并非针对你的数据执行的记录。
下载示例 ↓用于你自己的材料。
- 打开要处理的来源,并在该标签页中启用 WebAct。
- 复制页面顶部的任务,补充必需的字段或偏好,并检查建议执行的操作。
- 将首次结果与来源对照,必要时提出具体修改或完善要求。