devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Update the triage/triaging.rst page.

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

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 avatar Jul 12 '22 02:07 ezio-melotti

This is a nice improvement. IMO, when issues are closed, we should also encourage leaving a message regarding why it was closed, for example "implemented in the following PRs: <list of PRs>", "superseded by ", etc.

erlend-aasland avatar Jul 12 '22 08:07 erlend-aasland

Also, I made a review checklist for one of my PRs:

https://github.com/python/cpython/pull/93823#issuecomment-1156152572

Perhaps a generalised version could be added to the devguide?

erlend-aasland avatar Jul 12 '22 08:07 erlend-aasland

I added a mention of the triaged label and made a few other tweaks.

Perhaps a generalised version could be added to the devguide?

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 Aug 06 '22 18:08 ezio-melotti

I think the best approach would be to enhance the pull-request-lifecycle with your list, and remove the duplicated info in triaging.

SGTM! Thanks for making all these enhancements to our (documented) workflow.

erlend-aasland avatar Aug 06 '22 18:08 erlend-aasland

SGTM -- that's a nice list. I think it would be easier to add it in a separate PR though.

I created #962 to track this, so that we can start merging this and keep improving the devguide iteratively (as Diataxis suggests).

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