📌 项目地址：github/docs | ⭐ 19,690 颗星 | 🔧 TypeScript | 📜 未标注
这个仓库是什么
仓库 github/docs 是 docs.github.com 的源代码。所有官方教程、API 参考、快速入门、最佳实践都写在 /content 和 /data 下的 Markdown 文件里。仓库语言标记为 TypeScript，但那只是构建工具代码，外部贡献者不需要碰。
19690 颗星，原因是你的修改一旦合并，会同步到正式网站，每月几百万访问者能看到。
两个仓库的同步机制
GitHub 内部维护了两个文档仓库：
github/docs（公开）：接受外部贡献。github/docs-internal（私有）：仅限 GitHub 员工提交。
两个仓库频繁同步。README 里写：“Content changes in one are reflected in the other。”但公开仓库接受的内容类型有限制。
外部贡献者能改什么，不能改什么
你能改的：
/content/下的任何.md文件（例如content/get-started/quickstart/hello-world.md）。/data/reusables等目录下的数据文件（主要是一些可复用的文本片段）。
你不能改的：
package.json、package-lock.json等依赖文件。.github/workflows/下的 Actions 配置。- CSS、JS 等前端构建代码。
- 任何构建脚本。
README 原文说：“Infrastructure files, workflows, and site-building code are not open for external modification。”外部 PR 不能改动这些文件，防止影响网站安全和工作流程。
如果你是 GitHub 员工（hubbers），请走 docs-content 仓库的 CONTRIBUTING.md。外部贡献者只看 github/docs 里的 CONTRIBUTING.md 即可。
怎样贡献（基于 README 给出的资源）
README 为新手提供了四个外部资源：
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
典型的操作路线：fork 仓库 → clone 本地 → 创建分支 → 修改 .md 文件 → 提交 → 推送 → 发起 Pull Request。如果你只想修一个错别字，直接在 GitHub 网页上点铅笔编辑也能走完 Fork+PR 流程（仓库允许网页编辑）。具体步骤在 CONTRIBUTING.md 里写得更详细。
贡献者的实际收益
- 修改会同步到
docs.github.com，你的 GitHub 用户名会出现在 git 历史里，部分页面底部会显示贡献者头像。 - 不需要特殊权限，任何人都可以提 PR。
- 一个错别字修正、一个步骤补充，每天被几百万人阅读。
谁适合来提 PR
- 你踩过官方文档的坑（步骤遗漏、示例代码过期）。直接提交修改比发 issue 或去论坛发帖快得多，而且 review 通常很快。
- 你想做第一次开源贡献，找低门槛但影响力大的项目。改文档几乎不会搞坏网站（review 会拦下坏 PR），但你的改动每天被数百万用户看到。
- 你不是 GitHub 员工，只关注
github/docs。docs-internal不接受外部 PR。
许可证
- Creative Commons Attribution 4.0 —— 用于文档和内容（
assets、content、data文件夹下的文件），详见 LICENSE。 - MIT License —— 用于代码，详见 LICENSE-CODE。
你贡献的内容自动遵循 CC BY 4.0，其他人可以重用，只要署名。代码部分更宽松（MIT）。