GitHub 文档是开源的。任何人都可以为公共docs
存储库中的文档做出贡献:https://github.com/github/docs。GitHub 员工在一个名为docs-internal
的存储库副本中处理文档。这两个存储库会自动同步,以确保它们都与合并到任一存储库的main
分支中的更改保持最新。为简单起见,我们将在有关为 GitHub Docs 贡献内容的文章中将“文档存储库”称为“文档存储库”。
文档存储库是讨论和协作在此处发布的文档的地方 docs.github.com.
问题
问题用于跟踪贡献者可以帮助完成的任务。如果某个问题具有triage
标签,则表示我们尚未对其进行审查,您不应开始处理它。
如果您在文档内容或docs.github.com网站中发现需要更新的内容,请搜索开放的问题以查看是否有人报告了相同的问题。如果是新问题,请使用模板打开一个问题。我们将使用该问题来讨论您希望解决的问题。
注意
GitHub 员工应在私有docs-content
存储库中打开问题。
拉取请求
拉取请求是一种建议更改我们存储库中内容的方式。当我们合并这些更改时,它们将在 24 小时内部署到实时站点。
我们不接受对REST API 参考文档的贡献。如果您在 REST API 参考文档中发现任何不准确之处,请在rest-api-description
存储库中打开一个问题。
我们仅记录 GitHub 产品、功能、工具和扩展。我们可能会提及或链接到第三方工具以演示功能的工作原理,但我们不接受记录第三方工具或集成的拉取请求,除非它们是与 GitHub 共同开发的。
审查您自己的拉取请求
在将拉取请求标记为准备由其他人审查之前,您应该始终先审查您自己的拉取请求。
对于内容更改,请确保您
- 确认更改是否符合内容设计计划(如果有)中概述的用户体验和目标。
- 审查内容的技术准确性。
- 检查您的更改是否存在语法、拼写错误以及是否符合样式指南。
- 确保拉取请求中的文本易于翻译。有关更多信息,请参阅“编写可翻译的内容”。
- 检查新的或更新的 Liquid 语句以确认版本控制是否正确。有关更多信息,请参阅“文档版本控制”。
- 检查您已更改的任何页面的预览。提交拉取请求后,会自动生成预览,并将链接添加到拉取请求中。预览有时需要几分钟才能准备就绪。确认所有内容都按预期呈现。检查预览将帮助您识别问题,例如拼写错误、不符合样式指南的内容或由于版本控制问题而未呈现的内容。确保检查列表和表格的渲染输出,它们有时会出现难以在 Markdown 中识别的错误。
- 如果您的拉取请求中存在任何失败的检查,请对其进行故障排除,直到所有检查都通过。
支持
我们是一个小型团队,努力跟上不断变化的产品的文档需求。不幸的是,我们无法在此存储库中提供支持问题方面的帮助。如果您遇到与 GitHub 相关的任何问题(与我们的文档无关),请直接联系 GitHub 支持。在文档存储库中打开的任何请求支持的问题或拉取请求都将提供有关如何联系 GitHub 支持的信息,然后关闭并锁定。
如果您在使用 GitHub 帐户时遇到问题,请联系支持。
翻译
此网站已国际化,并提供多种语言版本。此存储库中的源内容以英语编写。我们通过内部流程自动执行翻译,并与专业翻译人员合作来本地化英语内容。
如果您发现翻译错误,请提出一个包含详细信息的问题。
我们目前不接受翻译内容的拉取请求。
网站政策
GitHub 的网站政策也发布在 docs.github.com 上。
如果您在网站政策部分发现错别字,您可以打开一个拉取请求来修复它。对于其他任何内容,请参阅site-policy
存储库中的“贡献”。