开源项目如何参与提交

本文目录导读：

1. 第一步：准备工作
2. 第二步：Fork 项目仓库
3. 第三步：将 Fork 的仓库克隆到本地
4. 第四步：创建并切换到新分支（重要）
5. 第五步：进行代码修改并提交
6. 第六步：将本地分支推送到你的 GitHub 仓库
7. 第七步：创建 Pull Request (PR)
8. 第八步：等待审核与沟通
9. 一些重要建议

参与开源项目（特别是提交代码）通常遵循一个标准流程，称为 Fork & Pull Request (PR) 模式，下面是详细的步骤指南,从入门到提交。

第一步：准备工作

1. 注册/登录 GitHub：绝大多数开源项目托管在 GitHub 上。
2. 安装 Git：在你的电脑上安装并配置好 Git。

   git config --global user.name "你的用户名"
   git config --global user.email "你的邮箱"

3. 找到合适的项目：如果你还没有特定目标，可以：
   • 去 GitHub Explore 感兴趣主题的新手项目。
   • 找带有 good first issue、help wanted 标签的 issue，这对新手非常友好,维护者通常会有耐心指导。

第二步：Fork 项目仓库

• 进入目标开源项目的 GitHub 页面。
• 点击右上角的 Fork 按钮。
• 这会复制一份完全一样的项目到你自己的 GitHub 账户下，你将在自己的这个复制品上工作,不会影响原项目。

第三步：将 Fork 的仓库克隆到本地

# 在自己的电脑上，把你 GitHub 上 fork 过来的项目克隆下来
git clone https://github.com/你的用户名/项目名.git
# 进入项目目录
cd 项目名

第四步：创建并切换到新分支（重要）

绝对不要在主分支（main 或 master）上直接修改代码，应该创建一个新的、有意义的特性分支。

# 创建并切换到新分支，例如修复一个 bug 或添加一个功能
git checkout -b 你的分支名称
# 示例名称：fix/login-bug 或 feat/add-dark-mode

第五步：进行代码修改并提交

1. 修改代码：使用你喜欢的编辑器（VS Code, Vim 等）修改文件。

2. 审查你的修改：

   git status  # 查看哪些文件被修改了
   git diff    # 查看具体修改了哪些内容

3. 暂存并提交：提交信息要清晰、简洁、符合项目规范。

   # 添加所有修改过的文件
   git add .
   # 或者只添加特定文件：git add 文件名
   # 提交，写一个有意义的提交信息
   git commit -m "fix: 修复用户登录时密码验证的bug"

   • 提交信息规范：很多项目使用 Conventional Commits 规范，如 feat: xxx, fix: xxx, docs: xxx, refactor: xxx，提交信息最好包含“为什么这样做”。

第六步：将本地分支推送到你的 GitHub 仓库

# 推送到你 fork 的仓库 (origin)，分支名就是你刚刚创建的分支名
git push origin 你的分支名称

第七步：创建 Pull Request (PR)

1. 推送成功后，打开你的 GitHub fork 页面（你的用户名/项目名）。
2. 你会看到一个醒目的横幅：“你的分支名称 had recent pushes”，旁边有一个 Compare & pull request 按钮,点击它。
3. 进入 PR 创建页面，通常包含两个关键部分：
   • 基础库 (base repository)：要合并到的目标仓库（即原项目，如 vuejs/core）。
   • 头部分支 (head repository)：你的分支（如 你的用户名/core:fix/login-bug）。
   • 描述：写清楚你改了什么、为什么改、以及如何验证，如果可以,附上截图或测试步骤。
   • 关联 Issue（推荐）：在描述末尾写上 Closes #123 或 Fixes #123，这样 PR 合并后对应的 Issue 会自动关闭。
4. 点击 Create pull request。

第八步：等待审核与沟通

• 等待维护者审核：他们可能会要求你修改、补充测试、或调整代码风格。
• 后续修改：如果审核者要求改动，你只需继续在本地同一个分支上修改并提交，再推送一次（git push），PR 会自动更新。
• 解决冲突（如果不幸遇到）：

  # 1. 同步上游仓库的最新代码到本地
  git remote add upstream https://github.com/原项目所有者/原项目名.git
  git fetch upstream
  # 2. 将上游的最新 main 分支合并到你的分支
  git merge upstream/main
  # 3. 手动解决冲突文件，git add . 和 git commit
  # 4. 推送
  git push

一些重要建议

1. 先从文档或 bug 修复开始：不要一上来就提大功能，从修复一个错别字、更新文档、修个小 bug 开始是最佳入门方式。
2. 阅读项目的 CONTRIBUTING.md：绝大多数成熟项目根目录下都有这个文件，里面会详细说明代码风格、测试要求、提交规范等。
3. 先沟通后动手：在着手修改前，最好先在对应的 Issue 下方留言，说明你想做这件事，并得到维护者的确认,这样可以避免做重复工作或不必要的工作。
4. 保持小批量、原子化的提交：一个 PR 只做一件事，不要在一个 PR 里既修 bug 又重构代码又加新功能。
5. 不要怕犯错：维护者通常很乐意帮助新人，只要你态度诚恳、积极沟通、愿意按规范修改。

完成这一切后，PR 被合并了，恭喜你，你已经是这个开源项目的贡献者了！你的名字会出现在贡献者列表中，如果没被合并，仔细阅读反馈并修改,保持学习的心态。