为一个GitHub项目做贡献，详细的流程指导。

type

status

date

slug

summary

一、准备工作（一次性）

这一步骤是将本地电脑和GitHub建立链接，这个设置只需要做一次，在之后就永远不需要了。

二、不是仓库成员：Fork 工作流（最常见）

适用于任何开源项目。核心是：Fork → Clone（你自己的仓库）→ 新分支开发 → 推送到你的 Fork → 发起 Pull Request（PR）。

1) Fork 并克隆

在 GitHub 打开目标项目（例如 org/repo），点击 Fork 到你的账号下，得到 yourname/repo。

2) 创建特性分支

3) 开发与提交

可选：运行质量检查（强烈建议）

仓库若有 CONTRIBUTING.md、README，照做；

若有 pre-commit、lint、tests，本地先跑：

4) 推送到你的 Fork

5) 在 GitHub 发起 PR

打开你的分支页面，点 Compare & pull request；

选择目标：org/repo 的 main；

填写 PR 标题、说明（动机、做法、影响范围、测试方式、截图/日志）；

提交 PR。

6) 代码评审与更新

有时评审期间上游有新的提交，需要同步并更新你的 PR：

评审意见修改后，继续 git add/commit/push，PR 会自动更新。

7) PR 合并 & 清理

PR 被合并后：

三、你是仓库协作者：直接分支工作流

略去 Fork，直接在上游仓库新分支开发。

四、保持 Fork 同步（长期维护）

也可以在 GitHub 网页端用 “Sync fork” 一键同步。

五、常用命令速查

查看/切换/删除分支

撤销与修正

变基与冲突处理

查看日志与差异

远程与来源

用 GitHub CLI（可选，效率很高）

六、提交与 PR 的“写法”建议（审稿友好）

先读文档：CONTRIBUTING.md / CODE_OF_CONDUCT.md / README；

小步提交：每个 commit 做一件事，信息清晰、可回滚；

遵循约定：使用 Conventional Commits（如 feat:、fix:、docs:…）；

补测试/文档：新增功能尽量带测试、更新 README/CHANGELOG；

描述清楚：PR 里写明动机、方案、风险、测试方式、截图或日志。