分享第一次PR的经历
一、fork仓库
首先需要有github的账户,将官方的仓库fork到自己的账号。
接下来就可以将仓库克隆到本地。
- 如果之前克隆过的话就可以添加一个远程的仓库就行
git remote add <fork> <url>
for:是远程仓库的别名
url:fork过后自己的仓库地址
- 如果之前没有克隆过的就可以直接克隆fork的仓库地址
二、新建一个分支
一般我们要向一个开源仓库提交一个pr的话,都需要新建一个分支。
git checkout -b <new-branch>
这个时候就会创建一个的分支,并且切换到该分支,此时我们就可以在该分支上开发。
三、commit push
1 、当我们开发完成的时候,想把代码推送到远端时,可以使用 git status
查看一下我们更改了那些东西,并决定要提交哪些文件。
-
使用
git add <file>
添加想要提交的文件 -
使用
git commit -m "xxx"
为此次的提交写上一些注释4.此时我们就可以把本地的更改推送我们fork之后的仓库
git push <fork> <new-branch>
fork是远程仓库的别名。可以使用git remote -v
查看
四、CI(非必须)
因为此次的pr是修改编译问题,所以需要添加ci
如果需要添加ci的内容的话,需要添加Personal Access Token。(需要有workflow
,如果之前有的话应该不用)
1.创建Personal Access Token
进入github的setting
选择令牌,生成令牌
勾选workflow,其他选项的话可以按需勾选。
创建成功之后会得到一个PAT,复制。(可以先存到txt中)
2.填加
git remote set-url <fork> https://<username>:<PAT>@github.com/<username>/<repository>.git
将 <username>
替换为你的 GitHub 用户名,将 <PAT>
替换为你生成的 Personal Access Token,将 <repository>
替换为你的仓库名称。
五、创建PR
此时登录github,在fork的仓库就可以看到
只需要点击绿色按钮就可以进行pr
因为此次pr是根据下面的这个issue,#<issue的编号>
所以我们就可以在模板文件中关联issue
最后点击创建pr就行
此时rtthread的代码审查人员就会对你的pr进行审查,在此期间可以和大佬多沟通。
如果顺利的话,最终 PR 能够被认可,那么我们的修改就可以合并到官方仓库了!
六、删除此次pr的分支
删除本地分支
$ git branch -D <new-brach>
删除远程fork仓库的分支
git push origin --delete <new-brach>
同步fork的分支和本地的
git pull
下次如果想重新提交一个pr的话,就可以在建一个新的分支。