Git 小贴士#

在 main 分支上变基#

这将使用上游 SciPy github 仓库的更改更新您的特性分支。如果您不是绝对需要这样做，请尽量避免这样做，除非您已经完成工作。第一步是用上游的新提交更新远程仓库。

git fetch upstream

接下来，您需要更新特性分支。

# go to the feature branch
git checkout my-new-feature
# make a backup in case you mess up
git branch tmp my-new-feature
# rebase on upstream main branch
git rebase upstream/main

如果您对上游也已更改的文件进行了更改，这可能会产生您需要解决的合并冲突。有关此情况的帮助，请参阅下文。

最后，在成功变基后删除备份分支。

git branch -D tmp

注意

在 main 分支上变基优先于将上游合并回您的分支。在处理特性分支时，不鼓励使用 git merge 和 git pull。

从混乱中恢复#

有时，您会搞砸合并或变基。幸运的是，在 Git 中，从这些错误中恢复相对简单。

如果您在变基过程中搞砸了

git rebase --abort

如果您在变基后发现搞砸了

# reset branch back to the saved point
git reset --hard tmp

如果您忘记创建备份分支

# look at the reflog of the branch
git reflog show my-feature-branch

8630830 my-feature-branch@{0}: commit: BUG: io: close file handles immediately
278dd2a my-feature-branch@{1}: rebase finished: refs/heads/my-feature-branch onto 11ee694744f2552d
26aa21a my-feature-branch@{2}: commit: BUG: lib: make seek_gzip_factory not leak gzip obj
...

# reset the branch to where it was before the botched rebase
git reset --hard my-feature-branch@{2}

如果您实际上没有搞砸，但存在合并冲突，则需要解决这些冲突。这可能是最棘手的事情之一。有关如何执行此操作的详细说明，请参阅这篇关于合并冲突的文章。

重写提交历史#

注意

仅对您自己的特性分支执行此操作。

您所做的提交中存在令人尴尬的错别字吗？或者，您可能做了一些您不希望后人看到的错误尝试。

这可以通过交互式变基完成。

假设提交历史记录如下所示

git log --oneline
eadc391 Fix some remaining bugs
a815645 Modify it so that it works
2dec1ac Fix a few bugs + disable
13d7934 First implementation
6ad92e5 * masked is now an instance of a new object, MaskedConstant
29001ed Add pre-nep for a copule of structured_array_extensions.
...

并且 6ad92e5 是 main 分支中的最后一次提交。假设我们想要进行以下更改

将 13d7934 的提交消息重写为更合理的内容。
将提交 2dec1ac、a815645、eadc391 合并为一个提交。

我们这样做如下

# make a backup of the current state
git branch tmp HEAD
# interactive rebase
git rebase -i 6ad92e5

这将打开一个编辑器，其中包含以下文本

pick 13d7934 First implementation
pick 2dec1ac Fix a few bugs + disable
pick a815645 Modify it so that it works
pick eadc391 Fix some remaining bugs

# Rebase 6ad92e5..eadc391 onto 6ad92e5
#
# Commands:
#  p, pick = use commit
#  r, reword = use commit, but edit the commit message
#  e, edit = use commit, but stop for amending
#  s, squash = use commit, but meld into previous commit
#  f, fixup = like "squash", but discard this commit's log message
#
# If you remove a line here THAT COMMIT WILL BE LOST.
# However, if you remove everything, the rebase will be aborted.
#

为了实现我们想要的目标，我们将对其进行以下更改

r 13d7934 First implementation
pick 2dec1ac Fix a few bugs + disable
f a815645 Modify it so that it works
f eadc391 Fix some remaining bugs

这意味着（i）我们要编辑 13d7934 的提交消息，以及（ii）将最后三次提交折叠为一个。现在我们保存并退出编辑器。

然后，Git 将立即弹出一个编辑器用于编辑提交消息。修改后，我们得到以下输出

[detached HEAD 721fc64] FOO: First implementation
 2 files changed, 199 insertions(+), 66 deletions(-)
[detached HEAD 0f22701] Fix a few bugs + disable
 1 files changed, 79 insertions(+), 61 deletions(-)
Successfully rebased and updated refs/heads/my-feature-branch.

并且历史记录现在看起来像这样

0f22701 Fix a few bugs + disable
721fc64 ENH: Sophisticated feature
6ad92e5 * masked is now an instance of a new object, MaskedConstant

如果出现错误，仍然可以按照上面所述的方式恢复。

在 github 上删除分支#

git checkout main
# delete branch locally
git branch -D my-unwanted-branch
# delete branch on GitHub
git push origin :my-unwanted-branch

（注意 test-branch 前面的冒号 :。另请参阅：guides/remove-a-remote-branch

浏览您的仓库#

要查看仓库分支和提交的图形表示

gitk --all

要查看此分支的提交的线性列表

git log

您还可以查看网络图可视化工具，用于您的 github 仓库。

反向移植#

反向移植是将提交到 scipy/main 中的新特性/修复复制回稳定发布分支的过程。为此，您需要基于要反向移植到的分支创建一个分支，从 scipy/main 中选择要挑选的提交，然后为包含反向移植的分支提交拉取请求。

首先，您需要创建将要工作的分支。这需要基于旧版本的 SciPy（而不是 main）。

# Make a new branch based on scipy/maintenance/1.8.x,
# backport-3324 is our new name for the branch.
git checkout -b backport-3324 upstream/maintenance/1.8.x

现在，您需要使用 git cherry-pick 将 main 中的更改应用到此分支。

# Update remote
git fetch upstream
# Check the commit log for commits to cherry pick
git log upstream/main
# This pull request included commits aa7a047 to c098283 (inclusive)
# so you use the .. syntax (for a range of commits), the ^ makes the
# range inclusive.
git cherry-pick aa7a047^..c098283
...
# Fix any conflicts, then if needed:
git cherry-pick --continue

您可能会在此处挑选时遇到一些冲突。这些冲突的解决方式与合并/变基冲突相同。不同的是，在这里您可以使用 git blame 来查看 main 和反向移植分支之间的差异，以确保不会出现任何问题。
将新分支推送到您的 Github 仓库
```
git push -u origin backport-3324
```
最后，使用 Github 创建拉取请求。请确保它是针对维护分支而不是 main，Github 通常会建议您针对 main 创建拉取请求。

将更改推送到主仓库#

这仅当您具有主 SciPy 仓库的提交权限时才相关。

当您在特性分支中有一组“准备好”的更改，可以用于 SciPy 的 main 或 maintenance 分支时，您可以将其推送到 upstream，如下所示

首先，在目标分支上合并或变基。
1. 只有少数不相关的提交，则优先选择变基
```
git fetch upstream
git rebase upstream/main
```
  请参阅在 main 分支上变基。
2. 如果所有提交都相关，则创建一个合并提交
```
git fetch upstream
git merge --no-ff upstream/main
```

检查您要推送的内容是否合理

git log -p upstream/main..
git log --oneline --graph

推送到上游

git push upstream my-feature-branch:main

注意

通常最好使用 git push 的 -n 标志，先检查一下您是否要将您想要的更改推送到您想要的位置。

Git 小贴士#

在 main 分支上变基#

从混乱中恢复#

重写提交历史#

在 github 上删除分支#

多人共享单个仓库#

浏览您的仓库#

反向移植#

将更改推送到主仓库#