怎么给github开源项目提交PR

在 GitHub 上提交一个 Pull Request (PR),核心是围绕 Fork → Clone → Branch → Change → Push → PR 这六个步骤展开的。

动手实操:从Fork到PR的六步详解

  1. Fork 原项目:Copy 一份到自己的地盘

    • 打开你想贡献的项目页面,点击右上角的 Fork 按钮。项目就被完整复制到你的 GitHub 账户下了
  2. Clone 到本地:把副本下载到自己电脑

    • 在本地终端(Terminal)执行 git clone 命令,其中 <> 里的内容要替换为你的 GitHub 用户名和仓库名

      git clone https://github.com/<你的GitHub用户名>/<仓库名>.git
      cd <仓库名>
      
  3. 创建新分支:建立自己的工作实验室

    • 为你的修改建立一个专属分支,避免污染主分支

    • 分支名取一个简洁的,能概括你工作的名称,比如 fix-typo 或 feature-add-login

      git checkout -b your-branch-name
      
  4. 修改并提交 (Commit):清晰记录每一步思考

    • 在刚创建的分支上进行代码编辑

    • git add 将修改的文件“暂存”起来

    • git commit 将暂存的修改正式“提交”到本地仓库。记得写清楚提交信息,说明你做了什么,比如 git commit -m "docs: fix typo in installation guide"

      git add .
      git commit -m "你的提交信息: 清晰描述本次修改的内容"
      
  5. Push 到远程:把成果推送回GitHub副本

    • 将你本地分支上的所有提交,推送到 GitHub 上你的 Fork 仓库中

      git push origin your-branch-name
      
  6. 创建 PR:正式提交你的申请

    • 推完代码回到GitHub,会出现 “Compare & pull request” 按钮,点击它就能进入 PR 创建页面

    • 在页面填好信息,别忘了指定 base(原项目),关联相关 Issue(用 Closes #123 关联)

      • 标题 (Title):像 fix: 修复了登录时的一个小Bug 这样简明扼要

      • 描述 (Description):说清楚你改了啥、为啥改、咋测的

    • 检查无误后,点击 Create pull request 就提交了

保持同步:让你的Fork与原项目“步调一致”

由于原项目在你修改代码期间可能更新,你 Fork 的版本可能会落后。为避免冲突,建议你在创建 PR 前,先将原项目的最新代码合并到自己的分支中。

  • git remote add upstream <原项目仓库URL>:添加一个指向原项目的远程仓库(只需要做一次)

  • git fetch upstream:获取原项目的最新更新

  • git rebase upstream/main:将你的修改“嫁接”到原项目最新的提交之上

  • git push origin your-branch-name --force-with-lease:将同步后的分支强制推送到你的远程 Fork 仓库(当本地分支同步后与远程差异较大时使用)

posted @ 2026-05-11 10:52  sximelon  阅读(70)  评论(0)    收藏  举报