在将更改提交给 GitHub Docs 团队进行审查之前,请完成以下列表以完成自我审查。
- 如果有内容设计计划,请确认你的更改符合计划中概述的用户体验和目标。
- 打开拉取请求后,请查看有关暂存的更改,以确认文章按预期呈现并与源匹配。 这有助于发现拼写错误、不遵循样式指南的内容或因版本控制问题而无法呈现的内容等问题。
- 检查更改的技术准确性。
- 查看整个拉取请求,以确保它遵循我们关于创建可翻译内容的指导。 有关详细信息,请参阅“编写要翻译的内容”。
- 检查语法、拼写以及是否符合风格指南。 有关详细信息,请参阅“风格指南”。
- 如果你添加了新的版本控制或对现有版本控制进行了更改,请在查看文章的每个可用版本时确认所做的更改按预期呈现。
- 如果拉取请求中存在任何失败的检查,请对其进行故障排除,直到全部通过。