Skip to content

Simplify Issue Templates #276

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

Open
mrocklin opened this issue Sep 24, 2022 · 7 comments
Open

Simplify Issue Templates #276

mrocklin opened this issue Sep 24, 2022 · 7 comments

Comments

@mrocklin
Copy link
Member

I wonder if perhaps we have overused issue templates. I know that when I personally raise an issue I just remove all of the requirements and move on. I don't spend the time to list my Dask verison, Python version, what happened, what I expected to happen, etc..

I suspect that actually most of us do this. A beginner may not though, and I suspect that our requests intimidate them.

I propose that instead we point to a couple of docs like MCVE and then be done. Thoughts?

@mrocklin
Copy link
Member Author

Also, for this repository it actually took me a minute to figure out how to raise an issue.

Screen Shot 2022-09-23 at 5 56 18 PM

@mrocklin
Copy link
Member Author

For reference, here is the bug report issue template.

<!-- Please include a self-contained copy-pastable example that generates the issue if possible.

Please be concise with code posted. See guidelines below on how to provide a good bug report:

- Craft Minimal Bug Reports http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports
- Minimal Complete Verifiable Examples https://stackoverflow.com/help/mcve

Bug reports that follow these guidelines are easier to diagnose, and so are often handled much more quickly.
-->

**What happened**:

**What you expected to happen**:

**Minimal Complete Verifiable Example**:

```python
# Put your MCVE code here
```

**Anything else we need to know?**:

**Environment**:

- Dask version:
- Python version:
- Operating System:
- Install method (conda, pip, source):

<!-- If you are reporting an issue such as scale stability, cluster deadlock.
Please provide a cluster dump state with this issue, by running client.dump_cluster_state()

https://distributed.dask.org/en/stable/api.html?highlight=dump_cluster_state#distributed.Client.dump_cluster_state

-->

<details>
<summary>Cluster Dump State:</summary>

</details>

@jrbourbeau
Copy link
Member

Thanks @mrocklin. I agree there's room for improvement.

Also, for this repository it actually took me a minute to figure out how to raise an issue.

Agreed this isn't a great experience. It'd be great if the GitHub UI made it easier to see opening a blank issue is an option. See #277 for a proposed improvement.

I also opened up dask/.github#20 with some suggestions to our existing bug report template.

@jrbourbeau
Copy link
Member

#277 and dask/.github#20 are in. @mrocklin is it okay to close this issue?

One additional follow-up I'd like to do is replace our current Python/package version requests with "Paste the output of dask version" once dask version exists

@jakirkham
Copy link
Member

Wonder if we should move "Release" below "Report a security vulnerability" (given the former is effectively an internal issue)

@jrbourbeau
Copy link
Member

That seems reasonable to me! Unfortunately, I couldn't find any information on how to change issue template ordering. Do others know how to do that?

@jakirkham
Copy link
Member

In conda-forge, we numbered the issue template files ( conda-forge/.github#18 ), which seemed to work

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

No branches or pull requests

3 participants