github / docs

GitHub Docs

GitHub Docs 欢迎来到 GitHub Docs!GitHub 的文档是开源的,这意味着公司内外的任何人都可以为其做出贡献。有关完整的贡献指南,请访问我们的贡献指南(contributing guide)。

Quick links by contributor type 按贡献者类型分类的快速链接

Hubbers (GitHub employees): See CONTRIBUTING.md in the docs-content repository for GitHub-specific processes. Hubbers(GitHub 员工): 请参阅 docs-content 仓库中的 CONTRIBUTING.md,了解 GitHub 特有的流程。

Open source contributors: See CONTRIBUTING.md in the docs repository for a quick-start summary. 开源贡献者: 请参阅 docs 仓库中的 CONTRIBUTING.md,获取快速入门摘要。

How we sync changes across Docs repositories 我们如何在文档仓库之间同步更改

There are two GitHub Docs repositories: 有两个 GitHub Docs 仓库:

  • github/docs (public): Open to external contributions
  • github/docs (公开):对外部贡献开放
  • github/docs-internal (private): For GitHub employee contributions.
  • github/docs-internal (私有):供 GitHub 员工贡献使用。

The two repositories sync frequently. Content changes in one are reflected in the other. Hubbers might prefer to post in docs when working with a customer, but docs has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to docs-internal. 这两个仓库会频繁同步。在一个仓库中的内容更改会反映在另一个仓库中。Hubbers 在与客户合作时可能更倾向于在 docs 中发布内容,但为了保护网站和我们的工作流程,docs 对其接受的贡献类型有限制。内部贡献通常应提交至 docs-internal。

Important: The docs repository accepts contributions to content files (.md files in /content and select /data sections like reusables only). Infrastructure files, workflows, and site-building code are not open for external modification. 重要提示: docs 仓库仅接受对内容文件的贡献(仅限 /content 中的 .md 文件以及 /data 中的部分选定部分,如 reusables)。基础设施文件、工作流和网站构建代码不对外开放修改。

New to contributing 贡献新手指南

Here are some resources to help you get started with open source contributions: 以下是一些帮助您开始开源贡献的资源:

  • Finding ways to contribute to open source on GitHub
  • 在 GitHub 上寻找开源贡献途径
  • Set up Git
  • 设置 Git
  • GitHub flow
  • GitHub 工作流
  • Collaborating with pull requests
  • 通过 Pull Request 进行协作

License 许可协议

This project is dual-licensed under: 本项目采用双重许可协议:

  • Creative Commons Attribution 4.0 - for documentation and content in the assets, content, and data folders (see LICENSE)
  • 知识共享署名 4.0 (Creative Commons Attribution 4.0) - 适用于 assets、content 和 data 文件夹中的文档和内容(请参阅 LICENSE)
  • MIT License - for code (see LICENSE-CODE)
  • MIT 许可证 - 适用于代码(请参阅 LICENSE-CODE)