devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Improve PR review checklist

Open ezio-melotti opened this issue 3 years ago • 3 comments

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:

  • https://devguide.python.org/getting-started/pull-request-lifecycle/#reviewing
  • https://devguide.python.org/triage/triaging/#reviewing-patches

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.

ezio-melotti avatar Oct 07 '22 05:10 ezio-melotti

Thanks for the PR! Can we close this?

erlend-aasland avatar Oct 10 '22 09:10 erlend-aasland

#914 only included the changes that I had initially created, and I now merged it to keep things moving incrementally like Diataxis suggests. The checklist you suggested in the comment linked above is more comprehensive and can still be integrated in the devguide to improve the current checklist, so I opened this issue as a reminder.

ezio-melotti avatar Oct 12 '22 06:10 ezio-melotti

@ezio-melotti Can I please work on this issue?

abdnafees avatar Nov 24 '22 20:11 abdnafees