适用对象：零基础新手、计算机专业学生、需规范协作的团队

目标：从注册账号到参与开源贡献，掌握 GitHub 完整工作流

第一章 GitHub 概述

1.1 什么是 GitHub

GitHub 是全球最大的代码托管平台与开发者社交网络。截至2025年，全球超过 1.5亿 开发者在使用，托管了超过 4.2亿 个开源项目。

你可以从四个维度理解它：

1.2 GitHub 与 Git 的关系

这是一个经典的初学者困惑，用一张表说清楚：

一句话理解：Git 是"引擎"，GitHub 是装上引擎、配了仪表盘和导航的"整车"。

1.3 为什么学生必须学 GitHub

技术名片：你的 GitHub 主页比学历更直接地证明你的编程能力

协作能力：现代软件开发100%依赖 Git 协作，这是基本素质

学习宝库：全球最优秀的代码都在上面，读源码是成长最快的方式

开源贡献：给知名项目提 PR 并合入的经历，含金量超过大多数证书

第二章 环境搭建与基础配置

2.1 注册 GitHub 账号

1）访问 github.com，点击右上角 Sign up

2）输入邮箱、密码、用户名

邮箱建议：优先使用 Gmail 或 Outlook，部分国内邮箱可能收不到验证邮件

用户名建议：简短、专业、易记，例如 zhangsan，避免 xXx_killer_xXx 这类

3）完成邮箱验证，否则无法创建仓库

2.2 安装 Git

Windows 系统：

1）访问 git-scm.com 下载安装包

2）一路默认安装即可

3）安装完成后，在桌面空白处右键，出现 "Git Bash Here" 即安装成功

macOS 系统：

bash

推荐先安装 Homebrew（brew.sh），然后：

brew install git

也可以从 git-scm.com 下载 macOS 安装包。

Linux 系统（Ubuntu/Debian）：

bash

sudo apt update

sudo apt install git

安装后验证：

bash

git --version

输出类似 git version 2.44.0 即安装成功

2.3 配置 Git 个人信息

这一步非常重要，你的每次提交都会附上这些信息：

bash

git config --global user.name "Your Name"

git config --global user.email "your-email@example.com"

注意：邮箱必须与 GitHub 账号的主邮箱一致（在 GitHub Settings → Emails 中查看），否则你的提交不会计入贡献图（绿墙）。

检查配置是否生效：

bash

git config --global --list

会显示 user.name 和 user.email

2.4 配置 SSH 密钥（强烈推荐）

SSH 密钥可以让你在推送和拉取代码时无需反复输入密码。

第一步：生成密钥

bash

替换为你的 GitHub 注册邮箱

ssh-keygen -t ed25519 -C "your-email@example.com"

一路按回车使用默认路径和空密码即可

如果你的系统较旧不支持 ed25519：

bash

ssh-keygen -t rsa -b 4096 -C "your-email@example.com"

第二步：复制公钥

macOS：

bash

cat ~/.ssh/id_ed25519.pub pbcopy

Windows（Git Bash）：

bash

cat ~/.ssh/id_ed25519.pub clip

Linux：

bash

cat ~/.ssh/id_ed25519.pub

手动复制终端输出的全部内容

第三步：添加到 GitHub

1）登录 GitHub，点击右上角头像 → Settings

2）左侧菜单选择 SSH and GPG keys

3）点击绿色按钮 New SSH key

4）Title 随意填（如"My Laptop"），Key 粘贴刚才复制的公钥

5）点击 Add SSH key

第四步：测试连接

bash

ssh -T git@github.com

出现 "Hi your-username! Youve successfully authenticated..." 即为成功

2.5 国内访问加速方案（学生必备）

由于网络原因，国内访问 GitHub 可能很慢甚至超时。以下方案按推荐度排序：

方案一：Watt Toolkit（原 Steam++）—— 免费、简单

1）下载安装 Watt Toolkit

2）打开软件 → 选择"网络加速" → 勾选"GitHub"

3）点击"一键加速"

4）现在 git clone、git push 速度会显著提升

方案二：配置 Git 代理（如果你已有代理工具）

bash

设置 HTTP/HTTPS 代理（替换为你代理工具的端口）

git config --global http.proxy http://127.0.0.1:7890

git config --global https.proxy http://127.0.0.1:7890

取消代理设置

git config --global --unset http.proxy

git config --global --unset https.proxy

方案三：使用国内镜像站点

某些开源项目在国内有镜像（如 Gitee 上的镜像仓库），可以直接从镜像 clone。

第三章 核心概念与单人工作流

3.1 七大核心概念

3.2 单人开发的日常循环

这是最基础的工作流，适合个人项目或学习记录：

bash

1. 查看当前状态（哪些文件被修改了）

git status

2. 查看具体修改了哪些内容（按 q 退出）

git diff

3. 将所有修改加入暂存区

git add .

或只加入特定文件

git add filename.py

4. 提交到本地仓库（生成一个存档点）

git commit -m "feat: 添加用户登录功能"

5. 推送到 GitHub（同步到云端）

git push origin main

完整循环示例：

bash

早上到实验室，先拉取最新的代码

git pull

今天要添加一个搜索框功能

...写代码...

写完一部分后

git status

git diff

git add .

git commit -m "feat: 实现搜索框的基本结构"

...继续写搜索的交互逻辑...

git add .

git commit -m "feat: 完成搜索结果的展示逻辑"

下班前，推送到 GitHub

git push

3.3 提交信息的规范写法（Conventional Commits）

好的提交信息是团队协作的基本素养。使用约定式提交格式：

text

<类型>: <简短描述>

<详细描述（可选）>

常用类型及使用场景：

反面示例（请不要这样写）：

update — 更新了什么？

fix bug — 修了什么 bug？

. — 无话可说？

第四章 团队协作黄金流程（分支 + PR）

这是 GitHub 最核心的价值所在。团队铁律：永远不要直接往 main/master 分支推送代码！

4.1 标准协作流程（完整版）

假设你要给一个开源项目（或公司项目）贡献代码：

第1步：Fork 原仓库

点击原仓库页面右上角的 Fork 按钮，这会在你自己的账号下创建一个副本。

第2步：克隆你 Fork 的仓库

bash

git clone git@github.com:你的用户名/项目名.git

cd 项目名

第3步：添加上游仓库地址

bash

将原仓库添加为 upstream，方便后续同步

git remote add upstream git@github.com:原作者/项目名.git

检查远程地址配置

git remote -v

应该显示：

origin git@github.com:你的用户名/项目名.git (fetch)

origin git@github.com:你的用户名/项目名.git (push)

upstream git@github.com:原作者/项目名.git (fetch)

upstream git@github.com:原作者/项目名.git (push)

第4步：创建功能分支（绝对不能省略！）

bash

创建一个新分支，并切换到它

git checkout -b feat/add-search

分支命名规范：feat/xxx（新功能）、fix/xxx（修Bug）、docs/xxx（文档）

第5步：开发并提交

bash

...写代码...

git add .

git commit -m "feat: 实现搜索功能的基本逻辑"

可以多次提交

git add .

git commit -m "feat: 添加搜索结果高亮显示"

第6步：同步上游最新代码（关键一步，新手最易忽略！）

bash

获取上游仓库的最新代码

git fetch upstream

将你的功能分支变基到上游的最新 main 上

git rebase upstream/main

如果出现冲突，解决流程：

bash

Git 会提示哪些文件有冲突

1. 手动编辑冲突文件，保留你想要的代码

2. 删除冲突标记 <<<<<<< ======= >>>>>>>

3. 将处理好的文件加入暂存

git add .

4. 继续变基过程

git rebase --continue

重复以上步骤直到 rebase 完成

第7步：推送到你的远程仓库

bash

git push origin feat/add-search

第8步：创建 Pull Request (PR)

1）回到 GitHub 上你 Fork 的仓库页面

2）点击黄色的 "Compare & pull request" 按钮

3）仔细填写 PR 标题和描述：

标题：简洁概括你做了什么（如 feat: 添加全局搜索功能）

描述：说明解决了什么问题、实现方式、如何测试、建议附上截图

4）点击 Create pull request

第9步：根据审查意见修改

代码审查者会在 PR 页面留评论，你需要：

bash

在你的功能分支上继续修改

...修改代码...

git add .

git commit -m "fix: 根据审查意见修改搜索逻辑"

git push origin feat/add-search

PR 会自动更新，不需要重新提交

第10步：PR 合并后清理

bash

切回主分支

git checkout main

拉取上游最新代码

git pull upstream main

同步你的 origin

git push origin main

删除本地功能分支

git branch -d feat/add-search

删除远程功能分支

git push origin --delete feat/add-search

速记卡片：Fork → Clone → 添上游 → 开分支 → 开发 → 同步上游 → 推送 → 开PR → 审查修改 → 清理

第五章 分支管理与冲突解决

5.1 分支操作速查

bash

查看所有分支

git branch -a

创建新分支

git branch feat/new-feature

切换到指定分支

git checkout feat/new-feature

创建并切换到新分支（一步到位）

git checkout -b feat/new-feature

删除本地分支（已合并）

git branch -d feat/old-feature

强制删除本地分支（未合并）

git branch -D feat/old-feature

删除远程分支

git push origin --delete feat/old-feature

重命名当前分支

git branch -m new-branch-name

5.2 合并策略：merge vs rebase

一般建议：

在自己的功能分支上，用 git rebase upstream/main 来同步上游

在 GitHub 上合并 PR 时，默认使用 "Create a merge commit"

5.3 冲突解决完整教程

冲突是怎么产生的？

当两个人修改了同一个文件的同一行代码，Git 无法自动决定保留哪一个，就会产生冲突。

冲突标记的含义：

text

<<<<<<< HEAD

这是当前分支的代码（你的）

=======

这是要合并进来的代码（别人的）

feat/some-feature

实战：手动解决冲突

场景：你和同事都修改了 app.py 文件中的 login() 函数。

bash

你尝试合并，出现冲突

git merge feat/colleague-feature

Auto-merging app.py

CONFLICT (content): Merge conflict in app.py

Automatic merge failed; fix conflicts and then commit the result.

打开 app.py，找到冲突区域：

冲突前的内容：

python

def login(username, password):

# 验证逻辑pass

产生冲突后的内容：

python

<<<<<<< HEAD

def login(username, password):

# 你的版本：添加了二次验证if verify_2fa(username):    return authenticate(username, password)

=======

def login(username, password):

# 同事的版本：添加了日志记录log_attempt(username)return authenticate(username, password)

feat/colleague-feature

正确解决方式（保留两人的改进）：

python

def login(username, password):

# 综合两人的改进log_attempt(username)if verify_2fa(username):    return authenticate(username, password)

解决后继续：

bash

标记冲突已解决

git add app.py

提交合并

git commit -m "merge: 合并登录功能改进，保留双重验证和日志"

或者如果是在 rebase 过程中

git add app.py

git rebase --continue

避免冲突的最佳实践：

开发前先 git pull 拉取最新代码

一个分支只做一件事，生命周期尽量短

经常和上下游同步，不要攒着代码好几天再推

第六章 高级功能应用

6.1 GitHub Pages（免费个人网站）

GitHub Pages 可以免费托管静态网站，非常适合搭建个人博客或项目文档。

方法一：用户/组织网站

创建一个名为 你的用户名.github.io 的仓库（注意：必须完全一致）

将你的 HTML/CSS/JS 文件推送到这个仓库

等待几分钟，访问 https://%E4%BD%A0%E7%9A%84%E7%94%A8%E6%88%B7%E5%90%8D.github.io 即可看到你的网站

示例：快速创建一个 Hello World 页面

bash

mkdir my-site

cd my-site

git init

echo "

Hello, Im Zhang San

" > index.html

git add .

git commit -m "first commit: create personal page"

git remote add origin git@github.com:你的用户名/你的用户名.github.io.git

git push -u origin main

方法二：项目文档网站

进入你的项目仓库 → Settings → Pages

在 "Source" 下拉菜单选择分支（如 main）和文件夹（如 /docs）

点击 Save，GitHub 会生成一个网址，访问即可看到项目文档

6.2 GitHub Actions（自动化流水线）

GitHub Actions 可以让你在代码推送后，自动运行测试、打包、部署。

核心概念：

Workflow：一个完整的自动化流程，定义在 .github/workflows/*.yml 文件中

Job：Workflow 中的一个执行单元，多个 Jobs 可以并行或串行

Step：Job 中的具体步骤，可以执行命令或调用已有的 Action

Action：可复用的自动化模块

示例：Python 项目的自动测试

在项目根目录创建 .github/workflows/test.yml：

yaml

name: Python Test

触发条件：推送到 main 分支时，或向 main 提 PR 时

on:

push:

branches: [main]

pull_request:

branches: [main]

jobs:

test:

runs-on: ubuntu-latest  # 运行环境steps:- name: 检出代码  uses: actions/checkout@v4- name: 设置 Python  uses: actions/setup-python@v5  with:    python-version: '3.12'- name: 安装依赖  run: |    python -m pip install --upgrade pip    pip install -r requirements.txt- name: 运行测试  run: pytest

每次你推送代码或提交 PR，GitHub 会自动运行这些测试，并显示是否通过。

6.3 GitHub Copilot（AI 编程助手）

GitHub Copilot 是由 OpenAI 和 GitHub 联合开发的 AI 编程助手，能根据上下文自动建议代码。

对学生免费：GitHub Copilot 对学生免费开放（需通过 GitHub Student Developer Pack 认证）。

核心功能：

代码补全：写出注释，AI 自动生成实现代码

多语言支持：Python、Java、C++、JavaScript 等主流语言都支持

错误修复：遇到 Bug 可让 Copilot 分析代码并提出修复建议

学生认证申请：

访问 GitHub Education

使用学校邮箱注册，或上传学生证照片

审批通过后，即可免费使用 Copilot 和众多开发工具

第七章 项目规范与最佳实践

7.1 推荐的项目目录结构

text

project-name/

├── README.md # 项目说明（必读）

├── CONTRIBUTING.md # 贡献指南

├── LICENSE # 开源许可证

├── .gitignore # 忽略不需要跟踪的文件

├── .github/

│ └── workflows/ # GitHub Actions 配置

│ └── test.yml

├── src/ # 源代码

│ └── main.py

├── tests/ # 测试代码

│ └── test_main.py

├── docs/ # 文档

│ └── index.md

├── requirements.txt # Python 依赖（以 Python 为例）

└── data/ # 数据文件（可能被 .gitignore 忽略）

7.2 .gitignore 文件的重要性

.gitignore 告诉 Git 哪些文件不需要跟踪。以下文件类型通常都应忽略：

编译产物：.class、.o、dist/、build/

依赖包：node_modules/、venv/、__pycache__/

敏感配置：.env、.secret、*.pem

系统文件：.DS_Store（macOS）、Thumbs.db（Windows）

IDE 文件：.vscode/、.idea/

示例 .gitignore（通用项目）：

gitignore

依赖包

node_modules/

venv/

__pycache__/

构建产物

dist/

build/

敏感配置

.env

*.pem

系统文件

.DS_Store

Thumbs.db

7.3 README.md 编写黄金模板

README 是你项目的门面。以下模板可以直接套用：

markdown

项目名称

一句简短的项目介绍（不超过20字）。

特性

特性一

特性二

特性三

效果展示

image

快速开始

环境要求

Python 3.8+

Node.js 18+

安装

“‘bash

git clone https://github.com/%E4%BD%A0%E7%9A%84%E7%94%A8%E6%88%B7%E5%90%8D/%E9%A1%B9%E7%9B%AE%E5%90%8D.git

cd 项目名

pip install -r requirements.txt

“‘

运行

“‘bash

python main.py

“‘

文档

详细文档请访问 Wiki

贡献

欢迎提交 Issue 和 Pull Request！详细规范请查看 CONTRIBUTING.md

许可证

本项目采用 MIT License

7.4 打造个人技术名片

主页美化：

创建一个和你用户名完全一致的仓库（如用户名为 zhangsan，就创建 zhangsan 仓库）

在这个仓库的 README.md 中写个人简介、技能栈、联系方式

这个 README 会直接显示在你的 GitHub 个人主页顶部

置顶代表作：

在个人主页的 "Popular repositories" 区域，点击 Customize your pins，将你最棒的 6 个项目置顶。

保持活跃：

经常提交代码，让贡献图（绿墙）保持常绿

参与开源项目的 Issue 讨论

给其他项目 Star 和 Fork 也是活跃的表现

第八章 教育场景应用

8.1 课程作业管理

学生可以将每次作业作为一个独立的仓库来管理：

bash

在课程组织下创建作业仓库

git clone git@github.com:学校名/课程名/作业1-张三.git

cd 作业1-张三

完成作业后提交

git add .

git commit -m "feat: 完成第一次作业，实现xxx功能"

git push

对学生的好处：

代码不再零散地存放在 U 盘或某台电脑上

老师可以查看提交历史，了解你的开发过程

可以和同学互相 Review 代码

对老师的好处：

所有学生的作业集中管理

可以精确看到每个人每次提交的时间和内容

防止作业抄袭（通过对比提交历史）

8.2 学生作品集搭建

建议做法：

创建一个 portfolio 仓库，使用 GitHub Pages 搭建在线作品集

每个课程项目创建一个独立仓库，便于单独展示

在 README 中写好项目描述和运行截图

作品集仓库结构示例：

text

zhangsan.github.io/

├── index.html # 主页：个人介绍

├── projects/

│ ├── ai-chatbot/ # 项目1：AI聊天机器人

│ ├── web-game/ # 项目2：网页小游戏

│ └── data-analysis/ # 项目3：数据分析项目

├── assets/

│ └── images/ # 截图和照片

└── README.md

8.3 参与开源项目的入门指南

寻找适合新手的项目：

1）在 GitHub 搜索框输入 good first issue 或 help wanted

2）看 Issues 标签，找到标有 good first issue 的简单任务

3）优先选择活跃的项目（最近一周有 Commit）

贡献流程（就是我们在第四章讲的）：

1）Fork 项目

2）创建分支

3）修改代码

4）提交 PR

5）根据维护者反馈修改

新手第一条 PR 的心态建议：

1）不一定非要改代码，修复一个文档错别字也是贡献

2）认真读项目的 CONTRIBUTING.md，尊重维护者的规则

3）被要求修改不要沮丧，这是正常的协作过程

第九章 常见问题与排错指南

9.1 网络与连接问题

9.2 认证与权限问题

9.3 推送与合并问题

9.4 回滚与撤销操作

bash

撤销工作区的修改（还没 add）

git checkout -- filename

取消已暂存的文件（已经 add 了）

git reset HEAD filename

撤销最近一次 commit（保留修改）

git reset --soft HEAD~1

撤销最近一次 commit（彻底丢弃修改）

git reset --hard HEAD~1

丢弃所有本地修改，恢复到远程版本

git fetch origin

git reset --hard origin/main

警告：git reset --hard 会永久删除未提交的修改，使用前务必确认！

第十章 学习资源推荐

官方资源：

1）GitHub Docs：官方文档，最权威

2）Git 官方文档：Git 本身的学习资料

3）GitHub Skills：交互式学习课程

推荐书籍：

1）《Pro Git》：Git 圣经，免费在线阅读

2）《GitHub入门与实践》：适合零基础

在线练习：

1）Learn Git Branching：可视化学习分支操作，强烈推荐

2）Oh My Git!：游戏化学习 Git

国内社区：

1）掘金、知乎、CSDN 有大量 Git/GitHub 教程

2）Gitee（码云）也有对应的 Git 教程

结语:

GitHub 是现代软件开发的基石。掌握它，你不仅能高效管理自己的代码，还能参与全球最前沿的开源项目。记住，最好的学习方式就是动手实践——从今天开始，创建你的第一个仓库，写下第一行 README，提交第一个 Commit。日积月累，你的 GitHub 主页将成为最好的技术名片。