Skip to content

GitHub ​

本篇面向第一次接触 GitHub 的新手,从注册账号讲到参与开源协作。

什么是 GitHub? ​

GitHub 是一个基于 Git 的代码托管平台,核心功能是代码存储、版本控制、团队协作,同时也是全球最大的开源社区,拥有海量开源项目(如 Vue、React、Python 官方库等),普通人可免费注册使用,用于管理个人项目、学习开源代码、参与团队开发。

提示

Git 与 GitHub 的本质区别:Git 是本地版本控制工具(管理电脑上的代码版本),GitHub 是远程代码托管平台(将本地代码上传到云端,方便共享和协作)。

账号注册 ​

  1. 访问 GitHub 官网,点击右上角 Sign up;

  2. 填写注册信息:

    • 用户名:建议英文 + 数字,避免特殊符号,将作为个人主页地址;
    • 邮箱:用于验证和接收通知;
    • 密码:建议复杂且牢记;
  3. 完成验证:根据提示完成人机验证(如拖动滑块、选择图片);

  4. 邮箱验证:登录注册邮箱,点击 GitHub 发送的验证链接,完成账号激活;

  5. 激活后,GitHub 会引导选择兴趣领域、编程技能,可跳过(后续可在设置中修改),完成注册。

警告

用户名一旦确定,后续修改会影响个人主页地址和仓库链接,建议谨慎选择;邮箱建议使用常用邮箱,避免丢失账号。

个人账号基础设置 ​

  1. 登录 GitHub 后,点击右上角头像,选择 Settings;

  2. 个人信息设置(Profile):

    • 上传头像:建议清晰的个人头像,提升辨识度;
    • 填写姓名和个人简介:简介可填写个人技能、联系方式、开源方向;
    • 个人主页地址默认是 github.com/用户名。
  3. 安全设置(Security):开启双重验证(Two-factor authentication)提升账号安全性,推荐。路径:Settings → Security → Two-factor authentication → Enable;

  4. 邮箱设置(Emails):确认注册邮箱已验证,可添加备用邮箱,设置通知邮箱偏好。

提示

可根据需求设置个性化主题(Settings → Appearance → Theme),切换浅色/深色模式。

仓库(Repository) ​

什么是仓库? ​

仓库是 GitHub 中存储项目的核心容器,相当于一个云端文件夹,可存储代码、文档、图片等各类文件,每个仓库对应一个独立的项目,支持版本控制、权限管理等功能。

分类:仓库分为 公开仓库(Public) 和 私有仓库(Private)——公开仓库可被所有 GitHub 用户查看、Fork(复刻),适合开源项目;私有仓库仅自己或授权用户可查看,适合个人项目、团队内部项目(免费账号可创建无限私有仓库)。

例如此教程就是托管在 GitHub 仓库里的,你可以点击右上角的八爪鱼图标查看。

创建仓库 ​

  1. 登录 GitHub 后,点击右上角 +,选择 New repository(新建仓库);

  2. 填写仓库信息:

    • Repository name(仓库名称):建议简洁明了,与项目主题一致(如 my-first-project、vue-demo);

    • Description(描述):可选,填写项目简介(如 GitHub 新手练习项目、个人博客源码);

    • Visibility(可见性):选择 Public(公开)或 Private(私有);

    • Initialize this repository with a README(初始化仓库时创建 README 文件):必选,README 文件是项目的说明文档,用于介绍项目功能、使用方法等;

    • Add .gitignore(添加忽略文件):可选,选择对应语言(如 Python、JavaScript),.gitignore 文件用于指定无需上传到 GitHub 的文件(如临时文件、依赖包、IDE 配置文件);

    • Add a license(添加许可证):可选,开源项目建议添加许可证(如 MIT License),明确项目的使用权限。

  3. 点击 Create repository,完成仓库创建,跳转至仓库主页。

仓库主页核心功能介绍 ​

仓库主页是操作项目的核心界面,重点关注以下功能区:

  • Code(代码):查看仓库内的所有文件,可直接在线编辑、下载文件;

  • Issues(问题):用于提交 bug、提出需求、讨论项目相关问题(团队协作、开源贡献常用);

  • Pull requests(PR):用于提交代码修改请求(如向开源项目贡献代码、团队内合并分支);

  • Actions(动作):用于自动化部署、测试项目(进阶功能,后续讲解);

  • Projects(项目):用于管理项目任务、进度(团队协作常用);

  • Wiki(维基):用于编写项目详细文档(如使用手册、开发文档);

  • Stars(星星):用于收藏仓库,方便后续查找,也是项目受欢迎程度的体现;

  • Fork(复刻):将他人的公开仓库复制到自己的账号下,可基于此进行修改、学习;

  • Clone(克隆):将仓库下载到本地电脑,方便本地编辑代码后上传。

仓库文件操作 ​

上传文件 ​

  1. 进入仓库主页,点击 Add file,选择 Upload files;

  2. 拖拽本地文件/文件夹到上传区域,或点击 choose your files 选择文件;

  3. 填写 Commit changes(提交说明):简要描述上传的内容(如 上传项目首页 HTML 文件、添加 README 文档),必填;

  4. 点击 Commit changes,完成文件上传,刷新页面即可看到上传的文件。

在线编辑文件 ​

  1. 进入仓库主页,点击需要编辑的文件(如 README.md);

  2. 点击文件右上角的铅笔图标(Edit this file),进入编辑界面;

  3. 编辑内容(如修改 README 的项目简介),编辑区支持 Markdown 格式;

  4. 填写 Commit changes(提交说明),描述修改内容(如 修改 README 项目简介,补充使用方法);

  5. 点击 Commit changes,完成文件修改。

删除文件 ​

  1. 进入仓库主页,点击需要删除的文件;

  2. 点击文件右上角的垃圾桶图标(Delete file);

  3. 填写 Commit changes(提交说明),描述删除原因(如 删除无用的测试文件);

  4. 点击 Commit changes,完成文件删除。

提示

文件删除后可通过历史提交记录找回,后续会讲解如何查看历史版本。

版本控制 ​

Commit(提交) ​

Commit 是 GitHub 版本控制的核心,相当于给当前的文件状态拍一张快照,每次修改、上传、删除文件后,提交一次 Commit,会记录下修改内容、修改人、修改时间,方便后续查看历史、回滚版本。

关键要点:每个 Commit 都有一个唯一的 Commit ID(一串字母+数字的组合),用于定位具体的版本;提交说明(Commit message)要简洁明了,准确描述本次修改的内容,方便自己和他人查看。

查看历史提交记录(History) ​

  1. 进入仓库主页,点击 Commits(位于仓库名称下方);

  2. 进入历史提交页面,可查看所有的 Commit 记录,包括提交时间、提交人、提交说明、Commit ID;

  3. 点击任意一条 Commit 记录,可查看本次提交的具体修改内容(新增内容标绿,删除内容标红);

  4. 若需要回滚到某个历史版本,点击该 Commit 记录的 Browse files,即可查看该版本的所有文件,也可下载该版本的代码。

分支(Branch) ​

什么是分支? ​

分支相当于项目的平行副本,默认情况下,每个仓库只有一个主分支(main/master,GitHub 目前默认是 main),用于存储稳定的代码。我们可以创建新的分支,在新分支上进行修改、测试,修改完成后再合并到主分支,避免直接修改主分支的稳定代码,减少冲突。

应用场景:团队协作中,每个人在自己的分支上开发功能,开发完成后提交 PR,合并到主分支;个人项目中,可创建分支测试新功能,避免影响主分支的正常运行。

创建分支 ​

  1. 进入仓库主页,点击分支下拉框(默认显示 main);

  2. 输入新分支的名称(建议简洁明了,与功能相关,如 feature/login、fix/bug1);

  3. 点击 Create branch: 分支名称,完成分支创建,自动切换到新分支。

切换分支 ​

进入仓库主页,点击分支下拉框,选择需要切换的分支,即可快速切换到对应分支,查看该分支的文件和提交记录。

合并分支(Merge) ​

当新分支的功能开发完成、测试通过后,需要将其合并到主分支(以 新分支合并到 main 分支 为例):

  1. 切换到 main 分支,点击 Pull requests → New pull request;

  2. 在 base 下拉框选择要合并到的分支(main),在 compare 下拉框选择要合并的新分支;

  3. 查看分支对比,确认修改内容无误后,点击 Create pull request;

  4. 填写 PR 标题和描述(说明合并的功能、修改内容),点击 Create pull request;

  5. 若没有冲突,点击 Merge pull request,再点击 Confirm merge,完成分支合并;

  6. 合并完成后,可选择删除已合并的分支(点击 Delete branch),避免分支过多杂乱。

警告

若两个分支修改了同一个文件的同一部分,会出现合并冲突,需要先解决冲突(后续进阶部分讲解冲突解决方法),再进行合并。

删除分支 ​

  1. 方法一:合并分支后,直接点击 Delete branch 删除已合并的分支;

  2. 方法二:进入仓库主页,点击分支下拉框,选择 View all branches,找到需要删除的分支,点击分支右侧的 垃圾桶图标,确认删除即可。

Issues ​

什么是 Issues? ​

Issues 是 GitHub 的协作沟通工具,用于提交 bug、提出功能需求、讨论项目问题、分配任务等,相当于项目的问题跟踪系统,每个 Issues 都有唯一的编号,可跟踪处理进度。

创建 Issues ​

  1. 进入仓库主页,点击 Issues → New issue;

  2. 选择 Issues 模板(若有,如 Bug report、Feature request),若无则直接填写;

  3. 填写标题(简洁明了,如 登录功能出现 bug,无法正常提交);

  4. 填写内容(详细描述问题:如 bug 的复现步骤、预期效果、实际效果;需求的具体内容等),可添加图片、代码片段辅助说明;

  5. 可选:添加标签(Labels),如 bug、enhancement(功能增强)、good first issue(适合新手的问题);

  6. 可选:添加负责人(Assignees),分配任务给具体人员;

  7. 点击 Submit new issue,完成创建。

Issues 管理 ​

  • 回复 Issues:进入某个 Issues 页面,在评论区输入回复内容,点击 Comment 即可;

  • 关闭 Issues:当问题解决、需求完成后,点击 Issues 页面的 Close issue,可选择关闭原因;

  • 重新打开 Issues:若关闭后发现问题未解决,可点击 Reopen issue,重新开启跟踪。

Pull Request(PR) ​

PR 的核心用途 ​

PR 不仅用于团队内部的分支合并,也是参与开源项目的核心方式——当你 Fork 了他人的开源仓库,修改了代码(如修复 bug、添加新功能)后,可通过 PR 向原仓库提交修改请求,原仓库维护者审核通过后,你的修改会被合并到原仓库,完成开源贡献。

向项目提交 PR ​

  1. Fork 开源仓库:进入目标开源仓库主页,点击右上角 Fork,将仓库复制到自己的账号下;

  2. 克隆自己账号下的仓库到本地(后续讲解 Git 命令行操作),或在线编辑仓库文件,完成修改(如修复 bug);

  3. 提交 Commit,记录修改内容;

  4. 进入自己账号下的该仓库,点击 Pull requests → New pull request;

  5. 选择分支对比:

    • base repository:原开源仓库,base:原仓库的主分支;
    • head repository:自己账号下的仓库,compare:自己修改的分支;
  6. 查看修改内容,确认无误后,填写 PR 标题和描述(详细说明修改的目的、内容,符合原仓库的贡献规范);

  7. 点击 Create pull request,提交 PR,等待原仓库维护者审核;

  8. 若审核有反馈,根据反馈修改代码,修改后会自动更新 PR,直至审核通过,完成合并。

警告

提交 PR 前,建议先查看原开源仓库的 CONTRIBUTING.md(贡献指南),了解贡献规范,避免 PR 被拒绝。

GitHub 加速 ​

访问加速 ​

可以使用各种镜像站,比如 https://bgithub.xyz、https://kkgithub.com 等。

警告

请注意:镜像站无法注册或登录账号,也无法进行仓库管理。

下载加速 ​

https://github.akams.cn/ 收集了大量加速网站。

代理加速 ​

  • 使用 Watt Toolkit 进行本地反代加速。
  • 使用梯子。

Released under the AGPL v3 License.