GitHub开源项目提交PR

GitHub上如果是自己玩项目比较简单,但如何协作贡献开源项目呢,这就比较有意思了。这里mark下我在贡献开源项目,比如inshellisense积攒的经验。

https://static.1991421.cn/2024/2024-03-17-144331.png

这里以项目inshellisense为例

  1. fork开源项目,microsoft/inshellisense => alanhg/inshellisense

  2. 新建分支,比如fix/file-template,进行开发

    • 有UT的话更新UT,确保测试通过
    • 这里不直接使用主分支,是因为主分支用来同步项目更新,避免开发中,原项目有了新commit
    • 同时新建分支也可以更好的利用分支名表示在做的修改是feat还是fix等
  3. 提交到上游即alanhg/inshellisense

  4. 开源项目microsoft/inshellisense如果有更新,拉取更新Sync fork

  5. 提交分支fix/file-template进行rebase with主干分支,确保最新已同步

  6. 重新推送到上游alanhg/inshellisense

  7. 发起Pull Request,详细描述改动,等待合并

    • 如果PR review中有任何问题,积极反馈及解决
  8. 合并成功即🎉

  9. 可以将分支fix/file-template删除,切换到主分支,如果还有新的贡献可重新走步骤5进行操作