从零开始长期给某开源社区提PR步骤记录

0 前提

安装好git后，在本地配置github账户

git config --global user.name [github账户名称]
git config --global user.email [github注册的邮箱]

verified（签名）your commit

确保已安装gpg工具，可以在git bash中使用gpgconf命令查看是否安装成功

生成密钥

gpg --full-generate-key #生成密钥命令，如实填写信息
gpg --list-secret-keys --keyid-format LONG #查看生成的密钥

红线即为keyid

（可选）git自动签名每一个提交

如果需要频繁签名，为了避免commit时忘记添加-S参数，可以进行以下配置

git config --global user.signingkey [上图红线所示keyid]
git config --global commit.gpgsign true

将生成的密钥登记到github上

导出密钥

gpg --export -a <keyid>

到自己的github主页，settings->SSH and GPG keys
按照提示将上图所示内容复制上去即可。

1 创建自己的远程仓库

明确社区接受pr的分支，将该分支fork到自己的github账户，得到远程仓库

2创建本地仓库和环境

在本地开发环境使用clone命令将远程仓库克隆到本地

git clone [复制自己远程仓库的https地址，应以.git结尾]

设置上游：

git remote add upstream [社区仓库的https地址，应以.git结尾]
git remote -v #查看与远程仓库的连接，origin是自己的仓库，upstream是社区仓库

personal access token

到自己的github主页，settings->developer settings->Personal access tokens -> Generate new token
跟据需要选择该token的应用场景
复制token，到开发环境下执行

git remote set-url [你的remote别名] https://[token]@[你的远程仓库地址]
一般remote的别名在clone仓库时默认为origin

3 开发和提交PR

3.0 一般流程

每次编辑前，在本地的main分支上（别的项目可能是master分支，反正就是本地主要分支，用于和社区远程仓库保持一致。本地名字可以随便起，一般就保持fork时的分支名，即与社区的分支名一致。也可以另外建一个分支用于追踪）执行fetch upstream，追踪一下社区最新代码。

git fetch upstream

再创建一个新的分支b1，切换到该分支，开发本次PR要解决的任务。

git branch b1
git checkout b1

不先在main分支进行同步再创建新分支的后果是，即使基于与之前不同的branch提交新的commit，push后该PR下会包含以前分支下的commit。

此外一个没有commit的修改在branch新分支时会一直保留直到在某个分支下提交。

完成开发后

git status #查看已改动文件、已保存到暂存区文件、已commit待push文件
git add . #将工作区内所有改动文件提交到本地暂存区
git add [文件名]#将指定文件提交到本地暂存区
git commit -S -m 'commit message'#将暂存区所有文件提交，且需要签名（输入github账户密码）
git commit -n [文件名] -m 'commit message'#commit指定文件
git push origin b1#将本地提交推送到自己的远程仓库b1分支下（如前所述分支名字是按需变化的）

打开自己的远程仓库，选择对应的分支，create pull request
按社区要求的格式完成PR相关信息的填写
务必检查自己仓库的分支和远程仓库的分支是否选择正确！！

3.1 接着别人修改的PR继续修改（自己的PR）

首先拉取他人的修改

git pull origin [该分支名]

在本地修改后再按普通流程add, commit, push即可。

3.2 接着别人修改的PR继续修改（别人的PR）

还没实践过，先放下别人的笔记

https://blog.csdn.net/yehuozhili/article/details/119647293
https://blog.csdn.net/weixin_45903995/article/details/126021367?spm=1001.2101.3001.6650.3&utm_medium=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7ERate-3-126021367-blog-119647293.pc_relevant_3mothn_strategy_and_data_recovery&depth_1-utm_source=distribute.pc_relevant.none-task-blog-2%7Edefault%7EBlogCommendFromBaidu%7ERate-3-126021367-blog-119647293.pc_relevant_3mothn_strategy_and_data_recovery&utm_relevant_index=6

4 后悔药

4.1 撤销add

git restore --staged <file> #将暂存区的文件从暂存区撤出，但不会更改文件

4.2 在本地撤销commit

git log #查看过往版本，会展示版本号、提交者、commit时的message、提交时间
git reset --soft [版本号]#本地仓库回滚到指定版本号，但是工作区不回滚，该版本之后的提交被撤销
git reset --hard [版本号]#本地仓库和工作区均被回滚

使用soft回滚后可以直接add，commit。只用hard回滚后，工作区没有新内容，没有可以add的文件，需要重新编辑后才能add。

4.3 push后

撤销PR下的部分commit，但是保留PR

撤销一个PR下的部分较晚的commit，保留较早的

git log #查看过往版本，会展示版本号、提交者、commit时的message、提交时间
git reset --hard [版本号]#本地仓库和工作区均被回滚
git pull origin [分支名] force#强制用本地落后的版本覆盖远程仓库新版本

再回到PR 页面检查是否达到目的

关闭整个PR

网上说之有接收方能关闭已经发起的PR
但是实践中发现可以直接在该PR页面，comments最底部找到close按钮，close后还可以reopen。