devguide

devguide copied to clipboard

Document auto-closing keywords for PRs.

2

Fixes now outdated #502 and supersedes #701.

ezio-melotti

Override RTD build commands to speed up docs build

6

Similar to https://github.com/python/peps/pull/2728. ReadTheDocs now has a beta feature to override the build commands: * https://twitter.com/readthedocs/status/1549145303801946112 * https://docs.readthedocs.io/en/latest/build-customization.html#override-the-build-process Right now, a whole bunch of dependencies are installed that we don't...

hugovk

More clearly document what the contents of NEWS entries should be

1

The devguide describes in great detail _how_ and _when_ to write NEWS entries (reST syntax, line length, using blurb, etc.), but it barely touches on the subject of what the...

erlend-aasland

Make it clearer that "automerge" exists and is preferred

5

And provide better instructions about how to merge manually. One thing that people don't realize is that the second PR number (in backport pull request) is autogenerated by GitHub, and...

Mariatta

Update the triage/labels.rst page.

2

This PR updates the `triage/labels.rst` page, that contained outdated references to removed/renamed labels and previous fields used by bpo. The PR is still a draft. The first commit documents the...

ezio-melotti

Add a Sphinx role to link to GitHub labels

7

This adds a `:gh-label:` role to link to a GitHub label on https://github.com/python/cpython. For example: * ``` `:gh-label:`docs` ``` -> `https://github.com/python/cpython/issues?q=is%3Aopen+sort%3Aupdated-desc+label%3Adocs` * ``` :gh-label:`skip news` ``` -> `https://github.com/python/cpython/issues?q=is%3Aopen+sort%3Aupdated-desc+label%3A%22skip+news%22` This makes...

hugovk

Improve the "Making Good PRs" section

13

I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the...

erlend-aasland

Add tricks for the Pull Requests review?

1

Hi all, I would like to add a small section or a paragraph about the review of the Pull Requests. For example, for us, the contributors and core-dev of Python...

matrixise

Make it clear that the `[awaiting ...]` labels are for the bots only.

2

The `[awaiting ...]` labels are meant to be automatically added by `bedevere` bot. Both `miss-islington` and `bedevere` rely on these labels in order to work properly, so it's like a...

Mariatta

Update the triage/triaging.rst page.

4

This PR updates the `triage/triaging.rst` page, which contained outdated references to bpo and HG's patch-based workflow. See https://cpython-devguide--914.org.readthedocs.build/triage/triaging/

ezio-melotti