跳至主要内容

关于为 GitHub 文档做贡献

您可以通过多种方式为 GitHub 文档内容做贡献。

本文内容

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

文档仓库是讨论和协作此处发布于 docs.github.com 的文档的场所。

问题

问题 用于跟踪贡献者可帮助完成的任务。如果问题带有 triage 标签,表示我们尚未审阅,您不应开始处理它。

如果您在文档内容或 docs.github.com 网站上发现需要更新的内容,请搜索已打开的问题以查看是否已有其他人报告相同的问题。如果是新问题,请使用模板打开一个问题。我们会在问题中讨论您希望修复的内容。

注意

GitHub 员工应在私有的 docs-content 仓库中打开问题。

拉取请求

A 拉取请求 是在我们的仓库中建议更改的方式。当我们合并这些更改后,它们将在 24 小时内部署到线上站点。

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

我们仅记录 GitHub 的产品、特性、工具和扩展。我们可能会提及或链接第三方工具以演示某个特性的工作方式,但除非该工具或集成与 GitHub 共同开发,否则我们不接受记录第三方工具或集成的拉取请求。

审查您自己的拉取请求

您应始终先审查自己的拉取请求,然后再将其标记为可供他人审阅。

对于内容更改,请确保您

  • 确认这些更改符合内容设计计划中概述的用户体验和目标(如果有的话)。
  • 审查内容的技术准确性。
  • 检查您的更改是否符合语法、拼写,并遵守 风格指南
  • 确保您拉取请求中的文本易于翻译。更多信息,请参阅 撰写可翻译内容
  • 检查新建或更新的 Liquid 语句,以确认版本控制是否正确。更多信息,请参阅 版本文档
  • 检查您所修改的页面的预览。提交拉取请求后会自动生成预览,并在拉取请求中添加链接。预览有时需要几分钟才能准备好。确认所有内容都如预期渲染。检查预览可以帮助您发现拼写错误、未遵循风格指南的内容,或因版本问题未渲染的内容。务必检查列表和表格的渲染结果,因为这些在 Markdown 中有时难以发现问题。
  • 如果您的拉取请求中有任何检查未通过,请排查并解决,直至全部通过。

支持

我们是一个小团队,努力跟上不断变化的产品所带来的文档需求。不幸的是,我们无法在此仓库中帮助处理支持问题。如果您在使用 GitHub 时遇到与文档无关的问题,请 直接联系 GitHub 支持。在文档仓库中提交的任何请求支持的 issue 或 pull request 都会收到如何联系 GitHub 支持的信息,然后被关闭并锁定。

如果您在 GitHub 账户上遇到问题,请联系 支持

翻译

本网站已实现国际化,可提供多种语言。此仓库中的源内容使用英文编写。我们通过内部流程实现翻译,并与专业译者合作对英文内容进行本地化。

如果您发现翻译错误,请提交包含细节的 issue。

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

站点政策

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

如果您在站点政策部分发现拼写错误,可以打开拉取请求进行修复。对于其他情况,请参阅 site-policy 仓库中的 贡献指南

© . This site is unofficial and not affiliated with GitHub, Inc.