matplotlib.github.com/3.7.4/devel/maintainer_workflow.html at main · matplotlib/matplotlib.github.com · GitHub

History

638 lines (452 loc) · 27.2 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

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

<!DOCTYPE html>

<head>

<title>Maintainer workflow — Matplotlib 3.7.4 documentation</title>

document.documentElement.dataset.mode = localStorage.getItem("mode") || "";

document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";

</script>

DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://matplotlib.org/devdocs/_static/switcher.json?v3.7.4-2-g03947d07cf';

DOCUMENTATION_OPTIONS.theme_switcher_version_match = '3.7.4';

</script>

title="Search within Matplotlib 3.7.4 documentation"

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

</head>

<a class="skip-link" href="#main-content">Skip to main content</a>

</form>

</div>

</label>

</a>

</div>

<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../users/index.html">User guide</a>

</li>

<a class="reference internal nav-link" href="index.html">Develop</a>

</li>

<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>

</li>

</ul>

</div>

</button>

</div>

</button>

</div>

stable

</button>

</div>

<label class="sr-only">Gitter</label></a>

</li>

<label class="sr-only">Discourse</label></a>

</li>

<label class="sr-only">GitHub</label></a>

</li>

<label class="sr-only">Twitter</label></a>

</li>

</ul>

</div>

</button>

</div>

</label>

</div>

</nav>

<a class="reference internal nav-link" href="../plot_types/index.html">Plot types</a>

</li>

<a class="reference internal nav-link" href="../gallery/index.html">Examples</a>

</li>

<a class="reference internal nav-link" href="../tutorials/index.html">Tutorials</a>

</li>

<a class="reference internal nav-link" href="../api/index.html">Reference</a>

</li>

<a class="reference internal nav-link" href="../users/index.html">User guide</a>

</li>

<a class="reference internal nav-link" href="index.html">Develop</a>

</li>

<a class="reference internal nav-link" href="../users/release_notes.html">Releases</a>

</li>

</ul>

</div>

</button>

</div>

stable

</button>

</div>

<label class="sr-only">Gitter</label></a>

</li>

<label class="sr-only">Discourse</label></a>

</li>

<label class="sr-only">GitHub</label></a>

</li>

<label class="sr-only">Twitter</label></a>

</li>

</ul>

</div>

Section Navigation

</p>

<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>

<li class="toctree-l1"><a class="reference internal" href="triage.html">Bug triaging and issue curation</a></li>

<li class="toctree-l1"><a class="reference internal" href="development_setup.html">Setting up Matplotlib for development</a></li>

<li class="toctree-l1"><a class="reference internal" href="development_workflow.html">Development workflow</a></li>

<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>

<li class="toctree-l1"><a class="reference internal" href="documenting_mpl.html">Writing documentation</a></li>

<li class="toctree-l1"><a class="reference internal" href="style_guide.html">Documentation style guide</a></li>

<li class="toctree-l1"><a class="reference internal" href="coding_guide.html">Pull request guidelines</a></li>

<li class="toctree-l1"><a class="reference internal" href="release_guide.html">Release guide</a></li>

<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>

<li class="toctree-l1"><a class="reference internal" href="min_dep_policy.html">Minimum version of dependencies policy</a></li>

<li class="toctree-l1 current active"><a class="current reference internal" href="#">Maintainer workflow</a></li>

<li class="toctree-l1 has-children"><a class="reference internal" href="MEP/index.html">Matplotlib Enhancement Proposals</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>

<li class="toctree-l2"><a class="reference internal" href="MEP/template.html">MEP Template</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP09.html">MEP9: Global interaction manager</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP10.html">MEP10: Docstring consistency</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP11.html">MEP11: Third-party dependencies</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP12.html">MEP12: Improve Gallery and Examples</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP13.html">MEP13: Use properties for Artists</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP14.html">MEP14: Text handling</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP15.html">MEP15: Fix axis autoscaling when limits are specified for one axis only</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP19.html">MEP19: Continuous Integration</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP21.html">MEP21: color and cm refactor</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP22.html">MEP22: Toolbar rewrite</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP23.html">MEP23: Multiple Figures per GUI window</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP24.html">MEP24: Negative radius in polar plots</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP25.html">MEP25: Serialization</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP26.html">MEP26: Artist styling</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP27.html">MEP27: Decouple pyplot from backends</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP28.html">MEP28: Remove Complexity from Axes.boxplot</a></li>

<li class="toctree-l2"><a class="reference internal" href="MEP/MEP29.html">MEP29: Text light markup</a></li>

</ul>

</li>

</ul>

<li class="toctree-l1"><a class="reference internal" href="license.html">Licenses</a></li>

<li class="toctree-l1"><a class="reference internal" href="color_changes.html">Default color changes</a></li>

</ul>

</div>

</nav>

</div>

</div>

</div>

</div>

<span id="id1"></span><h1>Maintainer workflow<a class="headerlink" href="#maintainer-workflow" title="Link to this heading">#</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 external" href="https://docs.scipy.org/doc/scipy/dev/gitwash/development_setup.html#linking-to-upstream" title="(in SciPy v1.11.3)"><span>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 notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>upstream-rw<span class="w"> </span>git@github.com:matplotlib/matplotlib.git

git<span class="w"> </span>fetch<span class="w"> </span>upstream-rw

</pre></div>

</div>

<h2>Integrating changes<a class="headerlink" href="#integrating-changes" title="Link to this heading">#</a></h2>

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

(<code class="docutils literal notranslate"><span class="pre">upstream-rw/main</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 notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>remote<span class="w"> </span>add<span class="w"> </span>someone<span class="w"> </span>https://github.com/someone/matplotlib.git

git<span class="w"> </span>fetch<span class="w"> </span>someone

git<span class="w"> </span>branch<span class="w"> </span>cool-feature<span class="w"> </span>--track<span class="w"> </span>someone/cool-feature

git<span class="w"> </span>checkout<span class="w"> </span>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="Link to this heading">#</a></h3>

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

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

git<span class="w"> </span>fetch<span class="w"> </span>upstream-rw

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

git<span class="w"> </span>rebase<span class="w"> </span>upstream-rw/main

</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>

</section>

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

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

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

git<span class="w"> </span>merge<span class="w"> </span>--no-ff<span class="w"> </span>upstream-rw/main

</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 notranslate"><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>

</section>

<h3>Check the history<a class="headerlink" href="#check-the-history" title="Link to this heading">#</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 notranslate"><div class="highlight"><pre><span></span>git<span class="w"> </span>log<span class="w"> </span>--oneline<span class="w"> </span>--graph

git<span class="w"> </span>log<span class="w"> </span>-p<span class="w"> </span>upstream-rw/main..

</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 notranslate"><span class="pre">upstream-rw/main</span></code>), and

including those that can be reached from current HEAD (implied with the <code class="docutils literal notranslate"><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 notranslate"><span class="pre">-p</span></code> option shows the diff for these commits in patch form.</p>

</section>

<h3>Push to trunk<a class="headerlink" href="#push-to-trunk" title="Link to this heading">#</a></h3>

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

</pre></div>

</div>

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

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

</section>

</article>

</div>

<i class="fa-solid fa-list"></i> On this page

</div>

Integrating changes

</a>

A few commits

</a>

</li>

A long series of commits

</a>

</li>

Check the history

</a>

</li>

Push to trunk

</a>

</li>

</ul>

</li>

</ul>

</nav>

</div>

</div>

</footer>

</main>

</div>

</p>

</div>

Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.2.6.<br>

</p>

</div>

Built from v3.7.4-2-g03947d07cf.

<br/>

</p>

</div>

</footer>

</body>

</html>

matplotlib.github.com/3.7.4/devel/maintainer_workflow.html at main · matplotlib/matplotlib.github.com · GitHub

Expand file tree

Breadcrumbs

maintainer_workflow.html

Latest commit

History

Breadcrumbs

maintainer_workflow.html

File metadata and controls