1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
.. _git-start:
====================================
Getting started with Git development
====================================
This section and the next describe in detail how to set up git for working
with the SciPy source code. If you have git already set up, skip to
:ref:`development-workflow`.
Basic Git setup
###############
* Developing with git can be done entirely without GitHub. Git is a distributed
version control system. In order to use git on your machine you must first
`install git <https://git-scm.com/downloads>`__.
* Introduce yourself to Git::
git config --global user.email you@yourdomain.example.com
git config --global user.name "Your Name Comes Here"
.. _forking:
Making your own copy (fork) of SciPy
####################################
You need to do this only once.
#. Set up and configure a github_ account
If you don't have a github_ account, go to the github_ page, and make one.
You then need to configure your account to allow write access - see the
``Generating SSH keys`` help on `github help`_.
#. Next, create your own `forked copy of SciPy
<https://docs.github.com/get-started/quickstart/fork-a-repo>`__.
Overview
========
::
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
In detail
=========
Clone your fork
---------------
#. Clone your fork to the local computer with ``git clone
https://github.com/your-user-name/scipy.git``
#. Investigate. Change directory to your new repo: ``cd scipy``. Then
``git branch -a`` to show you all branches. You'll get something
like::
* main
remotes/origin/main
This tells you that you are currently on the ``main`` branch, and
that you also have a ``remote`` connection to ``origin/main``.
What remote repository is ``remote/origin``? Try ``git remote -v`` to
see the URLs for the remote. They will point to your github_ fork.
Now you want to connect to the upstream `SciPy github`_ repository, so
you can merge in changes from trunk.
.. _linking-to-upstream:
Linking your repository to the upstream repo
--------------------------------------------
::
cd scipy
git remote add upstream https://github.com/scipy/scipy.git
``upstream`` here is just the arbitrary name we're using to refer to the
main SciPy_ repository at `SciPy github`_.
Just for your own satisfaction, show yourself that you now have a new
'remote', with ``git remote -v show``, giving you something like::
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)
To keep in sync with changes in SciPy, you want to set up your repository
so it pulls from ``upstream`` by default. This can be done with::
git config branch.main.remote upstream
git config branch.main.merge refs/heads/main
Your config file should now look something like (from
``$ 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
Update submodules
-----------------
Initialize git submodules::
git submodule update --init
This fetches and updates any submodules that SciPy needs (such as `Boost`).
Next steps
==========
You are now ready to start developing with SciPy. Check the
:ref:`contributor-toc` for more details.
.. include:: git_links.inc
|
