devdocs/devel/gitwash/maintainer_workflow.html at first_commit · matplotlib/devdocs

History

414 lines (359 loc) · 16.8 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

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

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

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

<head>

<title>Maintainer workflow — Matplotlib 2.0.2.post4416.dev0+g1df513f documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../../',

VERSION: '2.0.2.post4416.dev0+g1df513f',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.2.post4416.dev0+g1df513f documentation"

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

</head>

<body>

</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="git_resources.html" title="git resources"

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

<a href="development_workflow.html" title="Development workflow"

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

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

<li><a href="../../tutorials/index.html">tutorials</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="git_development.html" accesskey="U">Git for development</a> »</li>

</ul>

</div>

</a>

<br/>

</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="#">Maintainer workflow</a><ul>

<li><a class="reference internal" href="#integrating-changes">Integrating changes</a><ul>

<li><a class="reference internal" href="#a-few-commits">A few commits</a></li>

<li><a class="reference internal" href="#a-long-series-of-commits">A long series of commits</a></li>

<li><a class="reference internal" href="#check-the-history">Check the history</a></li>

<li><a class="reference internal" href="#push-to-trunk">Push to trunk</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="git_development.html">Git for development</a><ul>

<li>Previous: <a href="development_workflow.html" title="previous chapter">Development workflow</a></li>

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

</ul></li>

</ul>

</div>

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

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

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<span id="id1"></span><h1>Maintainer workflow<a class="headerlink" href="#maintainer-workflow" title="Permalink to this headline">¶</a></h1>

<p>This page is for maintainers — those of us who merge our own or other

peoples’ changes into the upstream repository.</p>

<p>Being as how you’re a maintainer, you are completely on top of the basic stuff

in <a class="reference internal" href="development_workflow.html#development-workflow"><span class="std std-ref">Development workflow</span></a>.</p>

<p>The instructions in <a class="reference internal" href="set_up_fork.html#linking-to-upstream"><span class="std std-ref">Linking your repository to the upstream repo</span></a> add a remote that has read-only

access to the upstream repo. Being a maintainer, you’ve got read-write access.</p>

<p>It’s good to have your upstream remote have a scary name, to remind you that

it’s a read-write remote:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git remote add upstream-rw git@github.com:matplotlib/matplotlib.git

git fetch upstream-rw

</pre></div>

</div>

<h2>Integrating changes<a class="headerlink" href="#integrating-changes" title="Permalink to this headline">¶</a></h2>

<p>Let’s say you have some changes that need to go into trunk

(<code class="docutils literal"><span class="pre">upstream-rw/master</span></code>).</p>

<p>The changes are in some branch that you are currently on. For example, you are

looking at someone’s changes like this:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git remote add someone git://github.com/someone/matplotlib.git

git fetch someone

git branch cool-feature --track someone/cool-feature

git checkout cool-feature

</pre></div>

</div>

<p>So now you are on the branch with the changes to be incorporated upstream. The

rest of this section assumes you are on this branch.</p>

<h3>A few commits<a class="headerlink" href="#a-few-commits" title="Permalink to this headline">¶</a></h3>

<p>If there are only a few commits, consider rebasing to upstream:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># Fetch upstream changes</span>

git fetch upstream-rw

<span class="c1"># rebase</span>

git rebase upstream-rw/master

</pre></div>

</div>

<p>Remember that, if you do a rebase, and push that, you’ll have to close any

github pull requests manually, because github will not be able to detect the

changes have already been merged.</p>

</div>

<h3>A long series of commits<a class="headerlink" href="#a-long-series-of-commits" title="Permalink to this headline">¶</a></h3>

<p>If there are a longer series of related commits, consider a merge instead:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git fetch upstream-rw

git merge --no-ff upstream-rw/master

</pre></div>

</div>

<p>The merge will be detected by github, and should close any related pull requests

automatically.</p>

<p>Note the <code class="docutils literal"><span class="pre">--no-ff</span></code> above. This forces git to make a merge commit, rather than

doing a fast-forward, so that these set of commits branch off trunk then rejoin

the main history with a merge, rather than appearing to have been made directly

on top of trunk.</p>

</div>

<h3>Check the history<a class="headerlink" href="#check-the-history" title="Permalink to this headline">¶</a></h3>

<p>Now, in either case, you should check that the history is sensible and you have

the right commits:</p>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git log --oneline --graph

git log -p upstream-rw/master..

</pre></div>

</div>

<p>The first line above just shows the history in a compact way, with a text

representation of the history graph. The second line shows the log of commits

excluding those that can be reached from trunk (<code class="docutils literal"><span class="pre">upstream-rw/master</span></code>), and

including those that can be reached from current HEAD (implied with the <code class="docutils literal"><span class="pre">..</span></code>

at the end). So, it shows the commits unique to this branch compared to trunk.

The <code class="docutils literal"><span class="pre">-p</span></code> option shows the diff for these commits in patch form.</p>

</div>

<h3>Push to trunk<a class="headerlink" href="#push-to-trunk" title="Permalink to this headline">¶</a></h3>

<div class="highlight-bash"><div class="highlight"><pre><span></span>git push upstream-rw my-new-feature:master

</pre></div>

</div>

<p>This pushes the <code class="docutils literal"><span class="pre">my-new-feature</span></code> branch in this repository to the <code class="docutils literal"><span class="pre">master</span></code>

branch in the <code class="docutils literal"><span class="pre">upstream-rw</span></code> repository.</p>

</div>

</div>

Last updated on Jul 16, 2017.

Created using <a

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

</div>

(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){

(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)

})(window,document,'script','//www.google-analytics.com/analytics.js','ga');

ga('create', 'UA-55954603-1', 'auto');

ga('send', 'pageview');

</script>

</body>

<!--Flipcause Integration v3.0// Flipcause Integration Instructions:

Install the following code block once in the website Header (after <head> tag) -->

<style>

.fc-black_overlay{

display:none; position: fixed; z-index:1000001; top: 0%;left: 0%;width: 100%;height: 100%;

background-color: black; filter: alpha(opacity=50); cursor:pointer; opacity:0.5;

}

.fc-white_content {

opacity:1; display:none; margin-top: -320px; margin-left: -485px; width:970px; height:640px;

position:fixed; top:50%; left:50%; border: none;z-index:1000002;overflow: auto;

}

.fc-main-box{

opacity:1; display:none; margin:15px auto 0 auto; width:930px; position:relative; z-index:1000003;

}

.fc-widget_close{

opacity:1; content:url(http://i1338.photobucket.com/albums/o691/WeCause/X_zpse4a7e538.png);

position:absolute; z-index=1000004; right:-16px; top:-16px; display:block; cursor:pointer;

}

.floating_button{

display: block; margin-top: 0px; margin-left: 0px; width:auto ; height: auto;

position:fixed; z-index:999999; overflow: auto;

}

@keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-moz-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-webkit-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-o-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@-ms-keyframes backfadesin {

from { opacity:0; }

to {opacity:.5;}

}

@keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; transform: translateY(20px);}

100% {opacity: 1; transform: translateY(0);}

}

@-moz-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -moz-transform: translateY(20px);}

100% {opacity: 1; -moz-transform: translateY(0);}

}

@-webkit-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -webkit-transform: translateY(20px);}

100% {opacity: 1; -webkit-transform: translateY(0);}

}

@-o-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -o-transform: translateY(20px);}

100% {opacity: 1; -o-transform: translateY(0);}

}

@-ms-keyframes fadesin {

0%{ opacity:0; }

50%{ opacity:0; }

75% {opacity: 0; -ms-transform: translateY(20px);}

100% {opacity: 1; -ms-transform: translateY(0);}

}

</style>

function open_window(cause_id) {

var protocol=String(document.location.protocol);

var new_url;

if( /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)){

new_url="https://www.flipcause.com/widget/"+cause_id

window.open(new_url);

}

else {

document.getElementById("fc-fade").style.display = "block";

document.getElementById("fc-fade").style.webkitAnimation = "backfadesin 1s";

document.getElementById("fc-fade").style.animation = "backfadesin 1s";

document.getElementById("fc-fade").style.mozAnimation = "backfadesin 1s";

document.getElementById("fc-light").style.display = "block";

document.getElementById("fc-light").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-light").style.animation = "fadesin 1.5s";

document.getElementById("fc-light").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.display = "block";

document.getElementById("fc-main").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-main").style.animation = "fadesin 1.5s";

document.getElementById("fc-main").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.display = "block";

document.getElementById("fc-close").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-close").style.animation = "fadesin 1.5s";

document.getElementById("fc-close").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.display = "block";

document.getElementById("fc-myFrame").style.webkitAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.animation = "fadesin 1.5s";

document.getElementById("fc-myFrame").style.mozAnimation = "fadesin 1.5s";

document.getElementById("fc-myFrame").src="https://www.flipcause.com/widget/"+cause_id;

}

function close_window() {

document.getElementById("fc-fade").style.display="none";

document.getElementById("fc-light").style.display="none";

document.getElementById("fc-main").style.display="none";

document.getElementById("fc-close").style.display="none";

document.getElementById("fc-myFrame").style.display="none";

}

</script>

</div><iframe id="fc-myFrame" iframe height="580" width="925" style="border: 0;

border-radius:5px 5px 5px 5px; box-shadow:0 0 8px rgba(0, 0, 0, 0.5);" scrolling="no" src=""></iframe></div>

</div>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

maintainer_workflow.html

Latest commit

History

maintainer_workflow.html

File metadata and controls