跳至主要内容

关于对 GitHub Docs 做出贡献

你可以通过多种方式为 GitHub Docs 内容做出贡献。

GitHub 文档是开源的。任何人都可以在公共docs 存储库中为文档做出贡献:https://github.com/github/docs。GitHub 员工在该存储库的一个副本中处理文档,该副本称为docs-internal。这两个存储库会自动同步,以使它们都与合并到任一存储库的main 分支中的更改保持最新。为了简单起见,我们在有关为 GitHub Docs 做出贡献的文章中将引用“文档存储库”。

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

问题

问题用于跟踪贡献者可以提供帮助的任务。如果一个问题带有 triage 标签,则我们尚未对其进行审查,你不应该开始处理它。

如果你在文档内容中发现了一些内容,或者 docs.github.com 网站上的一些内容应该更新,请搜索公开问题,看看是否还有其他人报告了相同的问题。如果是新问题,请使用 模板打开一个问题。我们将使用该问题来讨论你希望修复的问题。

注意:GitHub 员工应在私有 docs-content 存储库中打开问题。

Pull 请求

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

我们无法接受对 REST API 参考文档 的贡献。如果你发现 REST API 参考文档中有不准确之处,请在 rest-api-description 存储库中打开一个问题。

我们只记录 GitHub 产品、功能、工具和扩展。我们可能会提及或链接到第三方工具来演示某个功能如何工作,但我们不接受拉取请求来记录第三方工具或集成,除非它们是与 GitHub 共同开发的。

审查你自己的 Pull 请求

在你将自己的 Pull 请求标记为准备好供其他人审查之前,你应该始终先审查自己的 Pull 请求。

对于内容更改,请确保你

  • 确认更改符合内容设计计划(如果有的话)中概述的用户体验和目标。
  • 审查内容的技术准确性。
  • 检查你的更改是否符合语法、拼写和 风格指南
  • 确保您的 Pull Request 中的文本易于翻译。有关更多信息,请参阅“编写要翻译的内容”。
  • 检查新的或更新的 Liquid 语句,以确认版本控制是否正确。有关更多信息,请参阅“文档版本控制”。
  • 检查您已更改的任何页面的预览。在您提交 Pull Request 并添加链接到 Pull Request 后,将自动生成预览。预览有时需要几分钟才能准备好查看。确认所有内容均按预期呈现。检查预览将帮助您识别问题,例如错别字、不遵循样式指南的内容或因版本控制问题而未呈现的内容。确保检查列表和表格的呈现输出,有时这些内容可能存在难以在 Markdown 中识别的问题。
  • 如果您的 Pull Request 中有任何失败的检查,请对它们进行故障排除,直到它们全部通过。

支持

我们是一个小团队,努力跟上不断变化的产品的文档需求。遗憾的是,我们无法在此存储库中帮助解决支持问题。如果您遇到与 GitHub 相关的问题,与我们的文档无关,请直接联系 GitHub 支持。在文档存储库中提出的任何请求支持的问题或 Pull Request 都将获得有关如何联系 GitHub 支持的信息,然后关闭并锁定。

如果您对 GitHub 帐户遇到问题,请联系支持

翻译

此网站已国际化,并提供多种语言版本。此存储库中的源内容以英语编写。我们通过内部流程自动进行翻译,与专业翻译人员合作对英语内容进行本地化。

如果您发现翻译错误,请提出包含详细信息的问题。

我们目前不接受翻译内容的 Pull Request。

网站政策

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

如果您在网站政策部分中发现错别字,您可以打开一个 Pull Request 来修复它。对于其他任何内容,请参阅site-policy存储库中的“贡献”。