跳至主要内容

自我审查清单

在您提交拉取请求以供审查之前,您应该先自行审查。

在您将更改提交给 GitHub Docs 团队以供审查之前,请完成以下列表以完成您的自我审查。

  • 如果有内容设计计划,请确认您的更改符合计划中概述的用户体验和目标。
  • 在打开拉取请求后,在暂存环境中查看您的更改,以确认文章按预期呈现并与源代码匹配。这有助于发现诸如错别字、不符合样式指南的内容或由于版本控制问题而无法呈现的内容等问题。
  • 审查您的更改以确保技术准确性。
  • 审查您的整个拉取请求,以确保它遵循我们关于创建可翻译内容的指南。有关更多信息,请参阅 "编写可翻译的内容."
  • 检查您的更改是否符合语法、拼写和风格指南。有关更多信息,请参阅“风格指南”。
  • 如果您添加了新的版本控制或对现有版本控制进行了更改,请确认您的更改在查看文章的每个可用版本时按预期呈现。
  • 如果您的拉取请求中存在任何失败的检查,请对其进行故障排除,直到所有检查都通过。