😈记录我的第一次PR

故事开头

事情是这样的, 前几天我使用 pinia 数据持久化插件 pinia-plugin-persistedstate 时忘记了相关配置, 于是去官方文档查看。

在关于 storage 配置的位置, 我发现官方文档这里有一个文字错误, 多了一个 “的” 字, 于是我将其记录下来, 也是提前把它当作我的第一次 PR 来练手。

image



PR流程

接下来是我 PR 的流程

  1. 首先把你要提交 PR 的项目 Fork 到自己的仓库。点击 fork 按钮

image-20231204103548078

这个时候自己的仓库中 就有你 fork下来的项目了

image-20231204103742309



  1. 在自己的仓库中将 fork 的仓库 clone 到本地。

    1
    2
    # git clone '自己仓库中的项目地址'
    git clone 'https://github.com/2WeirDo/pinia-plugin-persistedstate.git'



  2. 与上游仓库建立连接

1
2
3
4
5
# 只需操作一次
git remote add upstream '开源项目源地址'  

# 查看远程仓库地址
git remote -v



  1. 代码 clone到本地之后，先切换一个新的分支，分支名最好紧贴这次更新的内容。分支的命名尽量简洁，并与解决的问题相关

为什么要切换到新分支呢 ? 因为你以后可能还需要进行新的 PR , 这样最好切换到新分支便于管理你的 PR, 避免混淆。

比如这里就是这个项目关于 fix-typo 的 PR。

1
2
# 创建并切换分支
git checkout -b fix-typo



  1. 在新分支修改代码并提交

注意看每个项目它可能会有自己的提交规范, 根据规范进行 PR

1
2
3
git add .
git commit -m "just a minor typo"
git push origin fix-typo



  1. 在自己的仓库中找到对应项目，打开 Pull requests Tab，点击 New pull request 按钮，新建一个 PR。

Pull requests Tab 会显示在我们的项目页面, 如果没有 则点击 Pull requests , 然后点击 New pull request

image-20231204105531892



  1. github 会帮我们自动选择刚刚提交的分支，你需要编写 PR 相关描述, 最后点击 Create pull request 即可。

最好使用英文



  1. 之后只需要等待管理人员批准审核 merge 你的 PR 即可



  1. 最后我们打开官方文档, 发现 typo 错误已经被修改。
image-20231204105627576



结语

这就是我第一次 PR 的经历了, 虽说是个 很小很水 的 PR , 不过拿来作为我对开源贡献的起步, 也是大有裨益的。

这样看我的 github 主页, 也显得不那么单调咯hhh😈

image-20231204105950328



❗ 注意 : 你可能会遇到一个问题 :

当你 fork 了一个项目, 正在开发的时候，可能源项目发生了改动或者其他人也在开发, 这样就使得你 fork 的项目与源项目不同步,

这个时候就需要去拉取源项目的代码, 进行一个合并, 具体流程可以查阅资料解决 b（￣▽￣）d　

日常琐碎
#开源
😈记录我的第一次PR
http://example.com/2023/12/04/第一次PR/
作者
weirdo
发布于
2023年12月4日
更新于
2023年12月5日
许可协议