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

Update issue template to include a checklist #5787

Closed
wants to merge 5 commits into from

Conversation

max-sixty
Copy link
Collaborator

This may be overly prescriptive. We've had a number of recent issues which aren't minimal and link to external data, and then these languish on the Issue Tracker unanswered. That's a loss of time for all involved — the reporter of the issue as well as the maintainers.

To the extent we can predict which issues will languish, it would be better to give that guidance up front, and encourage examples which are easier to engage with. So this introduces a checklist that people need to proactively fill out.

@github-actions
Copy link
Contributor

github-actions bot commented Sep 12, 2021

Unit Test Results

         6 files           6 suites   58m 39s ⏱️
16 227 tests 14 492 ✔️ 1 735 💤 0 ❌
90 558 runs  82 381 ✔️ 8 177 💤 0 ❌

Results for commit 586498a.

♻️ This comment has been updated with latest results.

@TomNicholas
Copy link
Member

I think this is necessary too - only thing I would add is something along the lines of "this will help you get your question answered faster!"

@mathause
Copy link
Collaborator

mathause commented Jan 6, 2022

Was this superseeded by #6119?

@max-sixty
Copy link
Collaborator Author

Not quite; since this given a specific checklist that people need to complete. Sorry I let this linger. I can finish soon-ish.

@max-sixty
Copy link
Collaborator Author

max-sixty commented Apr 27, 2022

@pydata/xarray

I've refreshed this, since I've been spending time in the issue tracker recently and would like to systematize myself out of the "please add an MVCE" triagooor.

I also added a empty binder notebook & link, so people can easily test against a current version of dependencies. I've been using this myself given my M1 has been prickly for some xarray dependencies. Binder is great.

I'd be up for making it more friendly, if possible. But I do think we should be strict on issue quality. Some claims:

  • Most people want to1 invest the time to make good issues, and the existing outcomes are mostly a gap of direction & nudging
  • An unanswered issue (of which we have many, unfortunately) is worse than no issue at all — people feel that there's no prospect of a resolution to their concerns
  • Bad issues take time away from good issues, and lower maintainers' willingness to spend time in the issue tracker
  • Friendliness is a virtue. It's difficult to be friendly when managing bad issues, it's very easy when dealing with good issues

This is the current draft:
image

And the checkboxes:

image

Footnotes

  1. or at least are not adverse to :)

@max-sixty max-sixty closed this Apr 27, 2022
@max-sixty max-sixty deleted the issue-template branch April 27, 2022 00:56
@mathause
Copy link
Collaborator

Your suggestion looks good - did you close this on purpose?

@max-sixty
Copy link
Collaborator Author

Sorry, thanks for letting me know, that was a mistake. I'll restore.

I've had some issues with my github scripts today...

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.

3 participants