Ctrl+K

开始使用 Git 进行开发#

本节和下一节详细介绍如何设置 git 以使用 SciPy 源代码。如果您已经设置好 git，请跳到开发工作流程。

基本的 Git 设置#

  • 使用 git 进行开发可以完全不使用 GitHub。Git 是一个分布式版本控制系统。为了在您的机器上使用 git，您必须首先安装 git。

  • 向 Git 介绍您自己

    git config --global user.email you@yourdomain.example.com
git config --global user.name "Your Name Comes Here"

创建您自己的 SciPy 副本（fork）#

您只需要执行一次此操作。

  1. 设置和配置一个 github 帐户

    如果您没有github帐户，请转到github页面并创建一个。

    然后，您需要配置您的帐户以允许写入访问权限 - 请参阅生成 SSH 密钥的github 帮助。

  2. 接下来，创建您自己的SciPy 的 fork 副本。

概述#

git clone https://github.com/your-user-name/scipy.git
cd scipy
git remote add upstream https://github.com/scipy/scipy.git
git submodule update --init

详细说明#

克隆您的 fork#

  1. 使用 git clone https://github.com/your-user-name/scipy.git 将您的 fork 克隆到本地计算机

  2. 调查。将目录更改为您的新仓库：cd scipy。然后git branch -a来显示所有分支。您会得到类似这样的内容

    * main
remotes/origin/main

    这告诉您，您当前位于main分支上，并且您还与origin/main有remote连接。远程仓库remote/origin是什么？尝试git remote -v查看远程的 URL。它们将指向您的github fork。

    现在您想要连接到上游SciPy github仓库，以便您可以合并来自主干的更改。

将您的仓库链接到上游仓库#

cd scipy
git remote add upstream https://github.com/scipy/scipy.git

这里的upstream只是我们用来指代SciPy在SciPy github上的主仓库的任意名称。

只是为了让您自己满意，请使用 git remote -v show 向您展示您现在有一个新的“远程”，给您类似这样的内容

upstream     https://github.com/scipy/scipy.git (fetch)
upstream     https://github.com/scipy/scipy.git (push)
origin       https://github.com/your-user-name/scipy.git (fetch)
origin       https://github.com/your-user-name/scipy.git (push)

为了与 SciPy 的更改保持同步，您希望设置您的仓库，使其默认从upstream拉取。这可以通过以下方式完成

git config branch.main.remote upstream
git config branch.main.merge refs/heads/main

您的配置文件现在应该看起来像这样（来自$ cat .git/config）

[core]
        repositoryformatversion = 0
        filemode = true
        bare = false
        logallrefupdates = true
        ignorecase = true
        precomposeunicode = false
[remote "origin"]
        url = https://github.com/your-user-name/scipy.git
        fetch = +refs/heads/*:refs/remotes/origin/*
[remote "upstream"]
        url = https://github.com/scipy/scipy.git
        fetch = +refs/heads/*:refs/remotes/upstream/*
[branch "main"]
        remote = upstream
        merge = refs/heads/main

更新子模块#

初始化 git 子模块

git submodule update --init

这将获取和更新 SciPy 需要的任何子模块（例如Boost）。

下一步#

您现在可以开始使用 SciPy 进行开发了。查看SciPy 贡献者指南了解更多详细信息。

在此页面上