关于参与编写 GitHub Docs

GitHub 文档是开放源代码的。 任何人都可以参与公共 docs 存储库中的文档编写： https://github.com/github/docs 。GitHub 员工在此文档的副本（名为 docs-internal ）中处理文档。 这两个存储库会自动同步，以使其保持最新状态，且将更改合并到任一存储库的 main 分支中。 为简单起见，我们将在有关参与 GitHub Docs 编写的文章中称之为“文档存储库”。

文档存储库是讨论和协作处理 docs.github.com 处发布的文档的地方。

问题

问题用于跟踪参与者可以提供帮助的任务。 如果某个问题具有 triage 标签，则表示我们尚未对其进行评审，还不应开始处理。

如果你在文档内容或 docs.github.com 网站中发现了应该更新的内容，请搜索未解决的问题，看看是否已经有其他人报告了同样的问题。 如果是新内容，请使用模板提出问题。 我们将通过你提出的问题来讨论你想要解决的问题。

拉取请求

拉取请求是一种在存储库中建议更改的方法。 当我们合并这些更改时，它们将在 24 小时内部署到实时站点。

我们无法接受对 REST API 参考文档的供稿。 如果在 REST API 参考文档中发现不准确的内容，请在 rest-api-description 存储库中提出问题。

我们只记录 GitHub 产品、功能、工具和扩展。 我们可能会提及或链接到第三方工具来演示相关功能的工作原理，但除非是与 GitHub 联合开发的，否则我们不接受对文档第三方工具或集成的拉取请求。

查看自己的拉取请求

在将自己的拉取请求标记为可供他人审阅之前，应始终先检查自己的拉取请求。

对于内容更改，请确保：

• 确认更改是否满足内容设计计划（如果有）中概述的用户体验和目标。
• 查看内容是否在技术上具有准确性。
• 检查语法、拼写的更改以及是否符合风格指南。
• 确保拉取请求中的文本易于翻译。 有关详细信息，请参阅“编写要翻译的内容”。
• 检查新的或更新的 Liquid 语句，确认版本控制是否正确。 有关详细信息，请参阅“对文档进行版本控制”。
• 检查已更改页面的预览情况。 提交拉取请求并将链接添加到拉取请求后，将自动生成预览。 有时需要等待几分钟，才能查看预览版。 确认所有内容均正常呈现。 检查预览有助于识别拼写错误、不符合风格指南的内容或因版本控制问题而未呈现内容等问题。 请务必检查列表和表的呈现的输出，这些内容有时在 Markdown 格式下存在难以识别的问题。
• 如果拉取请求中存在任何失败的检查，请对其进行故障排除，直到全部通过。

支持

我们是一个小型团队，努力跟上不断变化的产品的文档需求。 遗憾的是，我们无法解决此存储库中的支持问题。 如果遇到 GitHub 的问题（与我们的文档无关），请直接联系 GitHub 支持人员。 在请求支持的文档存储库中提交任何问题或拉取请求，都将获得有关如何联系 GitHub 支持人员的信息，然后问题会被关闭和锁定。

如果你的 GitHub 帐户出现问题，请联系支持人员。

翻译

该网站是国际化的，提供多种语言。 此存储库中的源内容以英语编写。 我们会自动进行翻译，采用内部流程，并与专业翻译人员合作来将英语内容本地化。

如果发现翻译错误，请提交问题并附上详细信息。

我们目前不接受有关已翻译内容的拉取请求。

站点政策

GitHub 的网站策略也在 docs.github.com 上发布。

如果在站点策略部分中发现拼写错误，可以提交拉取请求来修复它。 有关任何其他内容，请参阅 site-policy 存储库中的“参与编写”。