Improve PR review checklist

Open
#962 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-2 days
Newbie friendliness
32/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
github
Domain
documentation

Research direction

Read the Reviewing sections in the pull-request-lifecycle and triaging pages, then inspect the checklist in the linked CPython pull request comment. Consolidate the relevant checklist in pull-request-lifecycle and remove duplicated reviewing guidance from triaging; done means the two pages no longer repeat the same information.

Written by the indexing model from the issue text.

Description

topic-pull requests topic-triage type-bug type-feature

In https://github.com/python/cpython/pull/93823#issuecomment-1156152572 @erlend-aasland wrote a checklist about reviewing PRs.

In https://github.com/python/devguide/pull/914#issuecomment-1207257987, I suggested:

SGTM -- that's a nice list. I think it would be easier to add it in a separate PR though.
Reviewing PRs is currently documented in two places:

The former has been likely written from scratch after the HG->Git migration, whereas the latter formerly documented how to review patches attached to a bpo issue and then it has been adapted to GitHub. I think the best approach would be to enhance the pull-request-lifecycle with your list, and remove the duplicated info in triaging.

Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from python/devguide

All issues in python/devguide

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.