上游 · 理解本功能前需先掌握的(1):
下游 · 依赖/承接本功能的(0):
暂无下游(建议学完它再进阶)
前置依赖包含从属概念升级流程承接
边方向 = 学习顺序(A→B 表示先学 A 再学 B)
为什么需要它
心智模型
新建仓库时勾选的那几个选项——README、License、.gitignore——到底有什么用?它们构成了仓库的'骨架':README 是门面,License 是法律边界,.gitignore 是安全护栏。一个规范仓库从这三个文件开始。
历史背景 · 它为什么诞生诞生于 2012
诞生新仓库需要标准的README/LICENSE/.gitignore起步文件,此前必须手动创建或本地git init。2012-12-05上线"在GitHub上创建文件",浏览器直接新建文件并提供.gitignore模板库。
功能介绍
一个像样的仓库通常由三个基础文件支撑起骨架(repository skeleton)。README:以 Markdown 写的项目说明书,会自动显示在仓库首页,告诉访问者'这是什么、怎么用',是开源项目的第一门面。License(许可证):声明别人能否、以及如何复用你的代码——没有许可证的代码默认'保留所有权利',严格说别人不能合法使用,'真正的开源'必须有许可证。.gitignore:一份忽略规则文件,列出哪些文件不要纳入版本控制(如编译产物、临时文件、本地密钥),避免把无用的甚至敏感的文件推上 GitHub。创建仓库时一并勾选这三个选项,是零成本起步的最佳实践。
核心术语
仓库骨架(repository skeleton):仓库必备的基础文件结构README:自动显示在仓库首页的项目说明文件许可证(license):声明代码复用权限的法律文件忽略文件(.gitignore):列出不需纳入版本控制的文件的规则文件Markdown:README 等文档常用的轻量标记语言
适用场景
- 当你想让访问者一眼看懂项目是什么、怎么用,写 README 时
- 当你想让代码可以被他人合法使用,添加开源许可证时
- 当你想让 node_modules、build 目录等不被提交到仓库时
- 当创建仓库时被问到'要不要初始化 README'而犹豫时
怎么操作(网页 vs 命令行 双轨)
🖱️ 网页操作 (GitHub.com)
- 新建仓库时勾选 'Add a README file' 自动生成 README
- 在仓库页面 'Add file → Create new file' 可新建 README、LICENSE 或 .gitignore
- 在 'Add file → Choose a license' 中可从模板选择常见开源许可证
- 打开仓库首页即可看到 README 自动渲染的内容
⌨️ 命令行 (进阶)
git init && echo "# 我的项目" > README.md # 创建 READMEgit add .gitignore # 添加写好的忽略规则git status # 查看 .gitignore 是否正确忽略了目标文件
新手建议先从网页操作入手,熟悉概念后再尝试命令行。命令行是真实开发中更常用的方式。
与其他功能的关系
| 关系(前置依赖 / 包含从属 / 概念升级 / 流程承接) | 说明 |
|---|---|
| 流程承接创建仓库(Create Repository) | 创建仓库后可添加 README/License/.gitignore 骨架文件 |
官方文档
小结
SUMMARY
README 是门面、License 是法律边界、.gitignore 是护栏,三者构成规范仓库的骨架。创建仓库时一起勾选最省事。下一步:学会用 Star 和 Watch 发现、关注别人家的好项目。