Skip to content

[MRG] DOC: How to deal with stalled PR #12894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 5, 2019

Conversation

GaelVaroquaux
Copy link
Member

A paragraph in the contribution guidelines, following a comment by @reshamas
#12878 (comment)

The goal of this change is to make it easier to find the corresponding
information.
plans to continue working on the PR in the near future. Failure to
respond within a week implies that the PR is stalled.

Note that if the PR has received earlier comments on the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we be more "aggressive" and say that if the contributor hasn't shown any sign of activity for more than a month (whether it's a reply to a question, or just a commit), it is safe to shorten the wait?

I have often seen contributors claiming "I'll do it soon" but actually not do it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also maybe explicitly say that this can be bypassed for sprints, where waiting 1 day isn't an option?
CC @reshamas

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How's this:


A good etiquette for this is:

To determine whether a PR is active or stalled, ask the contributor if they plan to work on the PR in the future.

An example is:

It would be great if you could follow up on the work that you started. Please indicate if you will continue to work on it. Refer to the Stalled pull requests section
in the Contributing Document.

A "dynamic activity" is defined as one which moves the PR forward such as a commit or reply to a question. A "static activity" is one which does not, such as a status update.

Failure to respond within a week with a dynamic activity implies that the PR is stalled.

​For PRs which have not shown any type of activity for at least a month, the ​allotted timeframe for a dynamic activity is three days.

For PRs which are submitted during a sprint, it is expected that dynamic activity will take place during the sprint duration. Follow-up time frames post-sprint may be determined and adjusted by the sprint organizers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was more concerned about the possibility of picking up a stalled PR during a sprint, not about stalled PR that were submitted by sprint attendee (even though that's also an issue).

Sticking to the current text, sprint attendees would have to wait one day at least for the original contributor's response before working on a stalled PR, which doesn't make sense since sprints are often one-day long.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how would we know if a PR is stalled during a sprint?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that. It'd be nice if organizers tag those PRs with a "Sprint" tag.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about (that keeps it quite simple):

Failure to respond within 2 weeks with an activity that moves the PR forward will result in tagging that PR with "help wanted".

Follow-up for un-merged sprint PRs will be communicated to participants at the sprint, and those PRs will be tagged "sprint"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to include a summary of this discussion in the PR (keeping it short). I felt that it was important to explain what tagging "sprint" meant. I am not sure that I fully captured the essence of your thoughts @reshamas , feedback welcomed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GaelVaroquaux This works. I agree, shorter is better.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for this fruitful discussion.

Copy link
Member

@jnothman jnothman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is good. It sets a standard for contributors to adhere to in giving notice of activity

@GaelVaroquaux
Copy link
Member Author

Sorry, this PR has gotten stalled :).

I took in account the comments. Hopefully it's good for merge.

Copy link
Member

@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@qinhanmin2014 qinhanmin2014 merged commit 301c18e into scikit-learn:master Jan 5, 2019
@GaelVaroquaux
Copy link
Member Author

Thanks for merging, @qinhanmin2014, and to everybody for reviews and comments.

adrinjalali pushed a commit to adrinjalali/scikit-learn that referenced this pull request Jan 7, 2019
* **Taking over a stalled PR**: To take over a PR, it is important to
comment on the stalled PR that you are taking over and to link from the
new PR to the old one. The new PR should be created by pulling from the
old one.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If appropriate? Sometimes the old PR doesn't contain anything useful, in particular if the issue has been misunderstood.

jnothman pushed a commit to jnothman/scikit-learn that referenced this pull request Feb 19, 2019
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
xhluca pushed a commit to xhluca/scikit-learn that referenced this pull request Apr 28, 2019
koenvandevelde pushed a commit to koenvandevelde/scikit-learn that referenced this pull request Jul 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants