跳到正文

提交拉取请求

用可核对的描述提交文档改动,并在同一个拉取请求中回应审阅。

写明改动和验证

使用能指明范围的标题,比如“补充安装指南的 Node.js 版本要求”。在拉取请求(PR)描述中说明原页面的问题、改动的页面和已执行的预览或验证步骤。涉及翻译或同步时,写明对应的上游版本或提交。

有关联议题时,把 Issue 编号或标题写进描述。覆盖多页的改动可以按读者任务拆成独立 PR,使每个 PR 都有完整的上下文和可复查的结果。

提供可以复跑的描述

## 读者遇到的问题

写明页面、适用版本和读者卡住的步骤。

## 本次改动

列出受影响入口和改后的行为。

## 已验证

注明预览地址、执行命令、运行环境和观察结果。

处理翻译时,用翻译记录模板交代原文基准。只修链接时,也要写明实际打开过的页面和小节。

跟进审阅

把审阅要求的修订推送到当前 PR 的分支。逐条回应需要解释的意见,并在修订后更新验证结果。术语或范围需要决定时,说明原文含义、当前约定和影响页面,方便维护者作出判断。

提交前按审阅清单自查一遍。译文改动还需要核对审阅译文中的版本和语义检查。收到意见后,可以按审阅和合并记录修订及验证。