我已经在 Github 上提交了对开源项目的更改,并收到了一位核心团队成员的代码审查意见。
我想考虑审查意见来更新代码,然后重新提交。执行此操作的最佳工作流程是什么?根据我对 git/github 的有限知识,我可以执行以下任何操作:
将代码更新为新提交,并将初始提交和更新后的提交添加到我的拉取请求中。不知何故(??)从我的存储库中回滚旧提交,并创建一个包含所有内容的新提交,然后为此提出拉取请求? git commit 有一个修改功能,但我听说在你将提交推送到本地存储库之外之后你不应该使用它?在这种情况下,我在本地 PC 上进行了更改并推送到我的项目的 github 分支。可以使用“修改”吗?还有什么?
似乎选项 2/3 会很好,因为开源项目在他们的历史中只有一个提交可以实现所有内容,但我不知道如何做到这一点。
注意:我不知道这是否会影响答案,但我没有在单独的分支中进行更改,我只是在 master 之上进行了提交
更新拉取请求
要更新拉取请求(第 1 点),您唯一需要做的就是检查拉取请求所在的同一分支并再次推送到它:
cd /my/fork
git checkout master
...
git commit -va -m "Correcting for PR comments"
git push
可选 - 清理提交历史
您可能会被要求将您的提交压缩在一起,以便存储库历史是干净的,或者您自己想要删除中间提交,这些提交会分散您的拉取请求中的“消息”(第 2 点)。例如,如果您的提交历史如下所示:
$ git remote add parent git@github.com:other-user/project.git
$ git fetch parent
$ git log --oneline parent/master..master
e4e32b8 add test case as per PR comments
eccaa56 code standard fixes as per PR comments
fb30112 correct typos and fatal error
58ae094 fixing problem
将事物压缩在一起是一个好主意,以便它们显示为单个提交:
$ git rebase -i parent/master
这将提示您选择如何重写您的拉取请求的历史记录,以下将在您的编辑器中:
pick 58ae094 fixing actual problem
pick fb30112 correct typos
pick eccaa56 code standard fixes
pick e4e32b8 add test case as per PR comments
对于您希望成为上一次提交的一部分的任何提交 - 将 pick 更改为 squash:
pick 58ae094 fixing actual problem
squash fb30112 correct typos
squash eccaa56 code standard fixes
squash e4e32b8 add test case as per PR comments
并关闭你的编辑器。然后 Git 将重写历史并提示您为一个组合提交提供提交消息。相应地进行修改,您的提交历史现在将变得简洁:
$ git log --oneline parent/master..master
9de3202 fixing actual problem
把它推到你的叉子上:
$ git push -f
Counting objects: 19, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (5/5), done.
Writing objects: 100% (11/11), 978 bytes, done.
Total 11 (delta 9), reused 7 (delta 6)
To git@github.com:me/my-fork.git
f1238d0..9de3202 HEAD -> master
并且您的拉取请求将包含一个提交,将之前拆分为多个提交的所有更改合并。
改变公共回购的历史是一件坏事
重写历史记录并在可能已被其他人克隆的分支上使用 git push -f
是一件坏事 - 它会导致存储库的历史记录和检出的历史记录发生分歧。
然而,修改你的 fork 的历史以纠正你提议集成到存储库中的更改 - 是一件好事。因此,毫无保留地从您的拉取请求中消除“噪音”。
树枝上的注释
在上面,我将拉取请求显示为来自您 fork 的 master
分支,这没有任何问题,但它确实会产生某些限制,例如,如果这是您的标准技术,则只能拥有一个 PR每个存储库打开。为您希望提出的每个单独更改创建一个分支是一个更好的主意:
$ git branch feature/new-widgets
$ git checkout feature/new-widgets
...
Hack hack hack
...
$ git push
# Now create PR from feature/new-widgets
只需将新提交添加到拉取请求中使用的分支,然后将分支推送到 GitHub。拉取请求将使用额外的提交自动更新。
#2 和#3 是不必要的。如果人们只想查看您的分支合并到的位置(而不是其他提交),他们可以使用 git log --first-parent
仅查看日志中的合并提交。
master
也是一个分支,所以从技术上讲它并不重要 :)
不定期副业成功案例分享
git push -f
之后,Github 删除了之前的对话。没有很多评论,但这是我没想到的。prune
不会删除该分离的提交,则其历史记录仍将与 PR 的评论相匹配。