首先,作为开源新手,你的操作流程一般是这样的:
🔹 克隆项目
-
Fork 项目(如果是贡献代码)
- 访问 GitHub 上的目标项目,例如
https://github.com/xxx/yyy
- 点击右上角的 Fork 按钮,将其 Fork 到自己的 GitHub 账户
- 进入你的仓库
https://github.com/你的用户名/yyy
- 复制仓库地址(
SSH
或HTTPS
)
- 访问 GitHub 上的目标项目,例如
-
克隆到本地
- 打开终端(Windows 可以用 Git Bash,Mac/Linux 直接用终端):
git clone https://github.com/你的用户名/yyy.git # 如果是 HTTPS # 或者使用 SSH: git clone git@github.com:你的用户名/yyy.git
- 进入项目目录:
cd yyy
- 打开终端(Windows 可以用 Git Bash,Mac/Linux 直接用终端):
🔹 代码开发
-
使用 IDEA 打开项目
- 启动 IntelliJ IDEA
File
→Open
→ 选择克隆的项目目录
-
创建新分支(推荐)
- 避免直接在
main
或master
分支开发,先新建分支:git checkout -b feature-xxx # 例如开发新功能 xxx
- 避免直接在
-
例如我做的是这个
-
开发代码 & 提交
- 在 IDEA 里修改代码
- 提交更改
git add . git commit -m "feat: 实现xxx功能"
🔹 同步远程仓库
-
同步原项目代码(如果是 Fork 的项目)
- 添加原仓库的远程地址
git remote add upstream https://github.com/原仓库作者/yyy.git
- 拉取最新代码
git fetch upstream git merge upstream/main # 或者 master,视原项目分支情况
- 添加原仓库的远程地址
-
推送代码到自己的仓库
- 把本地更改推送到远程 GitHub 仓库:
git push origin feature-xxx
- 把本地更改推送到远程 GitHub 仓库:
🔹 创建 Pull Request(PR)
-
提交 PR(如果是开源贡献)
- 进入 GitHub 你的 Fork 仓库
https://github.com/你的用户名/yyy
- 点击
Pull Request
→New Pull Request
- 选择 原项目的
main
作为base
,你的feature-xxx
作为compare
- 填写 PR 说明,然后提交
- 进入 GitHub 你的 Fork 仓库
-
等待 Maintainer 代码审核
- 可能会要求修改,你可以在本地修改后:
git add . git commit --amend -m "优化 xxx" git push origin feature-xxx -f # 强制推送更新 PR
- 可能会要求修改,你可以在本地修改后:
🔹 项目维护
- 如果 PR 被合并
- 你可以删除本地分支:
git branch -d feature-xxx git push origin --delete feature-xxx # 删除远程分支
- 同步 fork 仓库
git checkout main git pull upstream main git push origin main
- 你可以删除本地分支:
这样,你就完成了 GitHub 开源项目的完整贡献流程! 🚀