matplotlib.github.com/2.0.0/devel/gitwash/set_up_fork.html at main · matplotlib/matplotlib.github.com · GitHub

History

251 lines (225 loc) · 16.4 KB

Raw

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

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Set up your fork — Matplotlib 2.0.0 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.0.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.0 documentation"

href="../../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.0.0). For the latest version see <a href="https://matplotlib.org/stable/devel/gitwash/set_up_fork.html">https://matplotlib.org/stable/devel/gitwash/set_up_fork.html</a></div>

</map>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="configure_git.html" title="Configure git"

accesskey="N">next</a> |</li>

<a href="forking_hell.html" title="Making your own copy (fork) of matplotlib"

accesskey="P">previous</a> |</li>

<li><a href="../../examples/index.html">examples</a>| </li>

<li><a href="../../gallery.html">gallery</a>| </li>

<li><a href="../../api/pyplot_summary.html">pyplot</a>| </li>

<li><a href="../index.html" >The Matplotlib Developers’ Guide</a> »</li>

<li><a href="index.html" >Working with <em>matplotlib</em> source code</a> »</li>

<li><a href="setting_up_for_development.html" accesskey="U">Setting up for development</a> »</li>

</ul>

</div>

</a>

<br/>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<br/>

<h3><a href="../../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#overview">Overview</a></li>

<li><a class="reference internal" href="#in-detail">In detail</a><ul>

<li><a class="reference internal" href="#clone-your-fork">Clone your fork</a></li>

<li><a class="reference internal" href="#linking-your-repository-to-the-upstream-repo">Linking your repository to the upstream repo</a></li>

<li><a class="reference internal" href="#read-only-remote-push-access-to-matplotlib-matplotlib">Read-only remote / push access to <code class="docutils literal"><span class="pre">matplotlib/matplotlib</span></code></a></li>

</ul>

</li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../index.html">The Matplotlib Developers’ Guide</a><ul>

<li><a href="index.html">Working with <em>matplotlib</em> source code</a><ul>

<li><a href="setting_up_for_development.html">Setting up for development</a><ul>

<li>Previous: <a href="forking_hell.html" title="previous chapter">Making your own copy (fork) of matplotlib</a></li>

<li>Next: <a href="configure_git.html" title="next chapter">Configure git</a></li>

</ul></li>

</ul>

</div>

<li><a href="../../_sources/devel/gitwash/set_up_fork.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<p>First you follow the instructions for <a class="reference internal" href="forking_hell.html#forking"><span class="std std-ref">Making your own copy (fork) of matplotlib</span></a>.</p>

<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h2>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">clone</span> <span class="n">git</span><span class="nd">@github</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="n">your</span><span class="o">-</span><span class="n">user</span><span class="o">-</span><span class="n">name</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>

<span class="n">cd</span> <span class="n">matplotlib</span>

<span class="n">git</span> <span class="n">remote</span> <span class="n">add</span> <span class="n">upstream</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>

</pre></div>

</div>

<h2>In detail<a class="headerlink" href="#in-detail" title="Permalink to this headline">¶</a></h2>

<h3>Clone your fork<a class="headerlink" href="#clone-your-fork" title="Permalink to this headline">¶</a></h3>

<li><p class="first">Clone your fork to the local computer with <code class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span>

<span class="pre">git@github.com:your-user-name/matplotlib.git</span></code></p>

</li>

<li><p class="first">Investigate. Change directory to your new repo: <code class="docutils literal"><span class="pre">cd</span> <span class="pre">matplotlib</span></code>. Then

<code class="docutils literal"><span class="pre">git</span> <span class="pre">branch</span> <span class="pre">-a</span></code> to show you all branches. You’ll get something

like:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">*</span> <span class="n">master</span>

<span class="n">remotes</span><span class="o">/</span><span class="n">origin</span><span class="o">/</span><span class="n">master</span>

</pre></div>

</div>

<p>This tells you that you are currently on the <code class="docutils literal"><span class="pre">master</span></code> branch, and

that you also have a <code class="docutils literal"><span class="pre">remote</span></code> connection to <code class="docutils literal"><span class="pre">origin/master</span></code>.

What remote repository is <code class="docutils literal"><span class="pre">remote/origin</span></code>? Try <code class="docutils literal"><span class="pre">git</span> <span class="pre">remote</span> <span class="pre">-v</span></code> to

see the URLs for the remote. They will point to your <a class="reference external" href="https://github.com">github</a> fork.</p>

<p>Now you want to connect to the upstream <a class="reference external" href="https://github.com/matplotlib/matplotlib">matplotlib github</a> repository, so

you can merge in changes from trunk.</p>

</li>

</ol>

</div>

<span id="linking-to-upstream"></span><h3>Linking your repository to the upstream repo<a class="headerlink" href="#linking-your-repository-to-the-upstream-repo" title="Permalink to this headline">¶</a></h3>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">matplotlib</span>

</pre></div>

</div>

<p><code class="docutils literal"><span class="pre">upstream</span></code> here is just the arbitrary name we’re using to refer to the

main <a class="reference external" href="http://matplotlib.org">matplotlib</a> repository at <a class="reference external" href="https://github.com/matplotlib/matplotlib">matplotlib github</a>.</p>

<p>Note that we’ve used <code class="docutils literal"><span class="pre">git://</span></code> for the URL rather than <code class="docutils literal"><span class="pre">git@</span></code>. The

<code class="docutils literal"><span class="pre">git://</span></code> URL is read only. This means that we can’t accidentally

(or deliberately) write to the upstream repo, and we are only going to

use it to merge into our own code.</p>

<p>Note this command needs to be run on every clone of the repository

that you make. It is not tracked in your personal repository on

<a class="reference external" href="https://github.com">github</a>.</p>

<p>Just for your own satisfaction, show yourself that you now have a new

‘remote’, with <code class="docutils literal"><span class="pre">git</span> <span class="pre">remote</span> <span class="pre">-v</span></code>, giving you something like:</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">upstream</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span> <span class="p">(</span><span class="n">fetch</span><span class="p">)</span>

<span class="n">upstream</span> <span class="n">git</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span> <span class="p">(</span><span class="n">push</span><span class="p">)</span>

<span class="n">origin</span> <span class="n">git</span><span class="nd">@github</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="n">your</span><span class="o">-</span><span class="n">user</span><span class="o">-</span><span class="n">name</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span> <span class="p">(</span><span class="n">fetch</span><span class="p">)</span>

</pre></div>

</div>

<h3>Read-only remote / push access to <code class="docutils literal"><span class="pre">matplotlib/matplotlib</span></code><a class="headerlink" href="#read-only-remote-push-access-to-matplotlib-matplotlib" title="Permalink to this headline">¶</a></h3>

<p>If you have commit rights to <code class="docutils literal"><span class="pre">matplotlib/matplotlib</span></code> the <code class="docutils literal"><span class="pre">git://</span></code>

protocol URL will still be read-only (due to it not supporting

authentication and restrictions on github’s side). To reduce the

chance of accidentally pushing to upstream, we suggest setting up a

read-only remote of upstream as above and a read/write remote as</p>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">remote</span> <span class="n">add</span> <span class="n">DANGER</span> <span class="n">git</span><span class="nd">@github</span><span class="o">.</span><span class="n">com</span><span class="p">:</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>

</pre></div>

</div>

<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">remote</span> <span class="n">add</span> <span class="n">HOLY_COMMIT_RIGHTS_BATMAN</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">/</span><span class="n">matplotlib</span><span class="o">.</span><span class="n">git</span>

</pre></div>

</div>

</div>

Last updated on Feb 20, 2017.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.

</div>

</body>

</footer>

</html>

matplotlib.github.com/2.0.0/devel/gitwash/set_up_fork.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

set_up_fork.html

Latest commit

History

Breadcrumbs

set_up_fork.html

File metadata and controls