Skip to content

[CI] Add stalebot #481

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 4 commits into from
Sep 16, 2022
Merged

[CI] Add stalebot #481

merged 4 commits into from
Sep 16, 2022

Conversation

anton-l
Copy link
Member

@anton-l anton-l commented Sep 12, 2022

This will run the stale bot at 12:00 CET each day, commenting on issues that were inactive for 23 days, and closing them after another 7 days.

@anton-l anton-l changed the title Add stalebot [CI] Add stalebot Sep 12, 2022
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Sep 12, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Member

@pcuenca pcuenca left a comment

Choose a reason for hiding this comment

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

LGTM

@leszekhanusz
Copy link
Contributor

Oh no 😢 stalebot is awful, and 23 days is so little! So many real issues are going to be hidden!

@anton-l
Copy link
Member Author

anton-l commented Sep 13, 2022

@leszekhanusz fair point! We can disable the auto-closing, so that the bot only acts as a reminder to take another look at the issue.

@patrickvonplaten
Copy link
Contributor

Hmm, we make sure that no issue is closed without answer from us (that's why we have the reminder first).

If we don't have a bot that auto-reminds or auto-closes issues, we have to do it and this is often worse because it doesn't follow a 30 days schedule (so less predictable) and it creates much more overhead for maintainers (since they have to go through open-issues without a reminder to check whether it's resolved or not).

Most contributors opening an issue don't close it themselves after: #193 or things become simply stale because contributors don't answer anymore, e.g. #150

I'm very much in favor of adding a bot here

@leszekhanusz
Copy link
Contributor

Please let me propose an alternative: activating GitHub discussions on the repo.

You can activate the discussions tab and propose a few categories.

When an issue is posted, if it is not a clear bug or an enhancement well defined, then it should be moved directly to the discussions (like it is done on graphql-ws for example)

This would already reduce considerably the number of issues left.

For clear enhancement requests, they should be labelled as enhancement and you have to make a decision (it can be difficult, I know) about them:

  • either it is something you know already you will never accept in the repo and you close it manually, labelling it as wontfix
  • or it is something that could be done. You don't have to implement it but you would accept a PR if someone else did the work. In that case that enhancement request could stay on the issues page, even for years if needed.

I know that triaging issues takes time and sometimes asks for courage when you have to make the decision to decline an issue, I know that you currently have an increase of new issues recently, and thank you again for maintaining this repo, but it's way better in my opinion than to sweep things under the rug by using the stalebot.

#193 could be closed now or moved to discussions. When that happens in the repo I maintain, I close the issue after a few days by labeling it as waiting for feedback and ask to reopen if they have more info.
#150 could stay forever unless this is something you know you don't want to add to the repo, in the case it could be closed now.

There is nothing worse than going to GitHub to check for a problem you have and you see that the issue you have was already there 2 years ago, has many "me too" comments, and was closed a long time ago by the stale bot.

You could also ask for volunteers to triage issues if you need some help. Think about it.

@patrickvonplaten
Copy link
Contributor

Hey @leszekhanusz,

Thanks for the in-depth answer here! Hmm - I'm still not sure if the stale-bot really increases the number of unanswered issues.

Curious to hear what @LysandreJik and @sgugger think here (if you have time to take a quick look :-))

@sgugger
Copy link
Contributor

sgugger commented Sep 13, 2022

The stale-bot has been a very good workflow in Transformers. It does not necessarily suits every maintainer style, but it has worked pretty well with the way we work at Hugging Face. Note @leszekhanusz that we do not use Discussions since we have our forums and encourage people to post there when they open issues that are not well-defined, so it takes care of the first case you mention.

For the second case, issues with some predefined labels are not closed by the stale-bot (for Transformers we use Good first issues/WiP for instance).

@LysandreJik
Copy link
Member

I agree that the stale bot only fits certain maintainer styles and is not for every repository. It has been heavily criticized in the past and I can definitely understand why.

We activated it on transformers after the flow of issues was too high and we couldn't spend time properly closing each issue we couldn't address. If there are enough maintainers for diffusers, I don't see a problem with not enabling the stale bot for now!

@patrickvonplaten
Copy link
Contributor

patrickvonplaten commented Sep 13, 2022

Thanks a lot for the answers here @sgugger and @LysandreJik !
Ok - @anton-l should we then maybe just enable a "reminder" bot?

@patrickvonplaten
Copy link
Contributor

What is the status here? Should we adapt the config to just a reminder bot and then merge it?

@patil-suraj
Copy link
Contributor

Agree with Lysandre's comment here! For now we can just go ahead with "reminder bot, we can activate closing if we see number of stale issues blowing up.

@anton-l
Copy link
Member Author

anton-l commented Sep 16, 2022

Removed the closing part and added a stale label

@anton-l anton-l merged commit 214520c into main Sep 16, 2022
@anton-l anton-l deleted the add-stalebot branch September 16, 2022 13:54
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