文章目录
- [保姆级 GitHub 协作教程:从 clone 到提 PR 的完整流程](#保姆级 GitHub 协作教程:从 clone 到提 PR 的完整流程)
-
- [一、先分清 Git 和 GitHub](#一、先分清 Git 和 GitHub)
- [二、核心概念(先搞懂这 5 个)](#二、核心概念(先搞懂这 5 个))
- 三、环境准备
-
- [1. 装 git 并配置身份](#1. 装 git 并配置身份)
- [2. 认证(私有仓库必须)](#2. 认证(私有仓库必须))
- 四、完整流程(一步步来)
-
- [第 1 步:clone 仓库](#第 1 步:clone 仓库)
- [第 2 步:建分支](#第 2 步:建分支)
- [第 3 步:改文件、提交](#第 3 步:改文件、提交)
- [第 4 步:推送分支](#第 4 步:推送分支)
- [第 5 步:开 PR](#第 5 步:开 PR)
- [第 6 步:等代码评审](#第 6 步:等代码评审)
- [五、用 GitHub Desktop 操作(图形界面,新手友好)](#五、用 GitHub Desktop 操作(图形界面,新手友好))
- 六、命令速查表
- 总结
保姆级 GitHub 协作教程:从 clone 到提 PR 的完整流程
本文以一个真实任务(给团队仓库提交一个新文件)为例,讲清楚 GitHub 协作开发的全流程:clone → 建分支 → 提交 → 推送 → 开 PR → 代码评审。适合第一次参与团队项目的新人。
一、先分清 Git 和 GitHub
- Git :一个版本管理工具,在你电脑本地运行,管的是"代码的历史记录"。
- GitHub :一个托管代码的网站,把 Git 仓库放在云端,方便多人协作。
一句话:Git 是工具,GitHub 是网站。
二、核心概念(先搞懂这 5 个)
- 仓库(Repository):一个项目的代码 + 历史记录。
- 分支(Branch) :一条"独立的开发线"。
main是主干(正式代码),你做新功能要新建一个分支,在上面改,改完再合回主干。 - 提交(Commit):一次"存档",记录你改了哪些文件。
- 远程(Remote):GitHub 上的仓库,对应你本地的仓库。
- Pull Request(PR):申请"把我的分支合并进主干",让别人先审查。
为什么要用分支? 因为你不能直接在主干上改------改错了会影响所有人。分支就是你的"草稿",改好、别人审查通过,才合并进主干。
三、环境准备
1. 装 git 并配置身份
bash
git --version # 看装没装,没装就 sudo apt install -y git
git config --global user.name "你的GitHub用户名"
git config --global user.email "你的GitHub邮箱"
2. 认证(私有仓库必须)
私有仓库 clone 需要认证。两种方式:
- GitHub Desktop(推荐新手):登录 GitHub 账号即可,不用手动配 token。
- 命令行 :生成 Personal Access Token(Settings → Developer settings → Personal access tokens → Tokens (classic) → 勾
repo),然后:
bash
git clone https://用户名:token@github.com/组织名/仓库名.git
⚠️ token 是账号的钥匙,永远别贴到聊天、别贴进代码。更安全的做法是 clone 时不带 token,让 git 用密码提示问你,输入时不会显示。
四、完整流程(一步步来)
第 1 步:clone 仓库
bash
git clone https://github.com/组织名/仓库名.git
cd 仓库名
如果仓库有子模块 ,加
--recursive:git clone --recursive ...
第 2 步:建分支
bash
git checkout -b feat/你的功能名
分支命名习惯:feat/xxx(新功能)、fix/xxx(修 bug)、docs/xxx(文档)。
第 3 步:改文件、提交
bash
git status # 看改了哪些文件
git add 文件名 # 把改动加入暂存区
git commit -m "feat(scope): 描述" # 提交,message 要清晰
团队通常有提交信息规范(比如 Conventional Commits),照着写,别乱发挥。
第 4 步:推送分支
bash
git push -u origin feat/你的功能名
第 5 步:开 PR
推完后,git push 输出里会有一个开 PR 的链接,点开(或去 GitHub 仓库页面点 "Compare & pull request"):
- 确认方向:base = 主干分支 (如
main或develop),compare = 你的分支 - 填标题(会变成最终合并的 commit message,要完整、别太长)
- 填描述(按团队的 PR 模板写)
- 点 Create pull request
第 6 步:等代码评审
导师/同事会 review 你的 PR,可能:
- 直接 approve + merge → 完成 ✅
- 提意见让你改 → 你改文件 → 重新 commit → push 到同一个分支 → PR 自动更新 → 再等 review
五、用 GitHub Desktop 操作(图形界面,新手友好)
如果不想敲命令,GitHub Desktop 全程点鼠标:
- File → Clone repository → 搜仓库名 → clone
- 顶部 Current branch → New branch → 建分支
- 把改好的文件复制进仓库文件夹
- 左侧 Changes 里填提交信息 → 点 Commit
- 点 Publish branch 推送
- 点 Create Pull Request 开 PR
如果提示 "You don't have write access... Want to create a fork?",说明你对仓库只有读权限,走 fork(复刻)+ PR 流程:把仓库复制到你自己的账号下,推到你的 fork,再从 fork 向原仓库开 PR。
六、命令速查表
| 命令 | 作用 |
|---|---|
git clone 地址 |
克隆仓库 |
git checkout -b 分支名 |
新建并切换分支 |
git status |
看当前状态 |
git add . |
加入全部改动 |
git commit -m "信息" |
提交 |
git push origin 分支名 |
推送 |
git pull |
拉取远程更新 |
git log --oneline |
看提交历史 |
总结
团队协作的核心流程就一句话:建分支 → 改 → 提交 → 推送 → 开 PR → 评审 → 合并 。记住两件事:别直接在主干上改 、提交信息要规范,你就能顺利参与团队开发了。