DOC Detail superseded workflow for PRs #23220
Conversation
|
If we immediately close after having labelled the PR "superseded", is the label still necessary ? |
|
I think the label would be nice, cause in some cases we may not want to close immediately. This gives us a way to go back to the ones we've labeled but not closed. |
doc/developers/bug_triaging.rst
Outdated
| @@ -64,6 +64,10 @@ can do the following important tasks: | |||
| or needs help (this is typically very important in the context | |||
| of sprints, where the risk is to create many unfinished PRs) | |||
|
|
|||
| - If a stalled PR is taken over by a newer PR, then label the stalled PR as | |||
| "Superseded", leave a comment on the stalled PR linking to the new PR, and | |||
| close the stalled PR. | |||
There was a problem hiding this comment.
to leave some flexibility as mentioned in #23220 (comment)?
| close the stalled PR. | |
| possibly close the stalled PR. |
There was a problem hiding this comment.
We can say "likely" if we want to a nuance between the two.
I agree that the superseded label is still useful.
@adrinjalali In what cases do you want to keep a superseded PR open? As long as the stalled PR and the newer PR reference each other, we can still go between them. |
|
Sometimes he superseded PR is not directly superseded and rather as a biproduct of another PR. It's more like, if we manage to get that other PR in, it would also fix this PR, but we could still get this in if it gets done first. |
|
merging. 5 approvals should be enough :) |
Reference Issues/PRs
Related to #14570 (comment)
What does this implement/fix? Explain your changes.
This adds a policy to close stalled PRs when they become superseded. To me, closing superseded PRs is similar to closing duplicate issues. If a superseded PRs is closed, we signal to contributors that all new discussions continue on the new PR.
An extreme example are these 5 PRs on the same issue: #13042, #12285, #10168, #18094, #22562 where 4 of them are superseded.
CC @scikit-learn/core-devs @scikit-learn/contributor-experience-team