Skip to content
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

ci: mark issues and PRs as stale #2554

Merged
merged 3 commits into from May 3, 2024
Merged

Conversation

fgvieira
Copy link
Contributor

Description

QC

  • The PR contains a test case for the changes or the changes are already covered by an existing test case.
  • The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

@johanneskoester
Copy link
Contributor

I am unsure about this. Often, issues are inactive because of us devs not having the time to answer all of them in time, not because of the contributors. Is there any accepted polite strategy to take this into account?

@johanneskoester
Copy link
Contributor

A good way to get progress into an issue is to create a PR with a test case that reproduces the issue. Maybe rather than closing them automatically after some time, we could have some bot logic that checks whether an issue is linked to a PR and if not the logic could add a label first, noting that the issue needs a PR that adds at least a test case?

@johanneskoester
Copy link
Contributor

Only for bugs of course, not for enhancement requests. Also, I think that enhancement requests should never be marked as stale.

@fgvieira
Copy link
Contributor Author

fgvieira commented Jan 9, 2024

I think we can still mark issues and PR as stale since, even though it is probably due to devs not having enough time, they are still stale. What we could definitely do, is disable closing issues; this way they would just be marked stale.

Apart from that, for issues/bugs, I like the idea of checking if a PR exist with a test case that reproduces the error, but not quite sure how to implement it. How would you link the issue to the PR? If the PR is referenced? By the issue or PR name?

@johanneskoester
Copy link
Contributor

I think we can still mark issues and PR as stale since, even though it is probably due to devs not having enough time, they are still stale. What we could definitely do, is disable closing issues; this way they would just be marked stale.

Ok, agreed!

Apart from that, for issues/bugs, I like the idea of checking if a PR exist with a test case that reproduces the error, but not quite sure how to implement it. How would you link the issue to the PR? If the PR is referenced? By the issue or PR name?

Yes, that is also unclear to me. I have no good solution to be honest.

@fgvieira
Copy link
Contributor Author

fgvieira commented Jan 15, 2024

Or we can also set the closing of a stale issue only after a long time (e.g. one year). After a long time, it is likely that the issue might not be relevant, or need re-testing with the newest version.

Either way, it will force the user to do something and/or remind the devs if the issue is still relevant. This will help to clean up irrelevant (or where the user lost interest) issues and make easier for devs to focus on the important issues. Right now, the longer an issue is open, the less likely it is someone will find it (since it drowns among all the other issues).

@johanneskoester
Copy link
Contributor

Ok, that sounds good. So we mark as stale first, and after one year of being stale, we close it automatically.

@fgvieira
Copy link
Contributor Author

fgvieira commented Feb 19, 2024

Done for issues.
PRs are never close, right?

Copy link

sonarcloud bot commented Feb 19, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@johanneskoester johanneskoester merged commit e43cfe3 into snakemake:main May 3, 2024
35 checks passed
@fgvieira fgvieira deleted the mark_stale branch May 3, 2024 10:00
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.

None yet

2 participants