-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add pep-723 style script to bug report issue template #10707
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
Conversation
this seems great! thanks! I would vote to have this as "suggested" for a month before turning it on as required, to assess how it goes? |
.github/ISSUE_TEMPLATE/bugreport.yml
Outdated
Please list dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example). | ||
When put in a file named `issue.py` calling `uv run issue.py` should show the issue. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would make this a little weaker, maybe "Consider listing" instead of "Please list". Not everyone has uv
installed, e.g., if they are running Xarray from a managed Python environment like Google Colab.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've updated that language. and added explicit permission to delete teh suggesiton in the box. For reasons in the main thread I think it's important to leave it as a copypastable rather than the suggestion (grayed out) text.
This is definitely a nice nudge, but it won't be feasible for everyone, so I would suggest making the ask a little weaker. |
I changed the language to make it more ok to ignore the inline metadata, and said that its explicitly ok to not use it
Do you mean to have it as the grayed-out suggestion text? The issue with that is that it creates a lot of friction, as it is not copy-pasteable. As it stands, you can still delete the suggestion here. You can see this in action here: https://github.com/zarr-developers/zarr-python/issues/new?template=bug_report.yml |
I just meant "suggested" colloquially — similar to the others' feedback re "Consider" etc |
Co-authored-by: Maximilian Roos <[email protected]>
Co-authored-by: Maximilian Roos <[email protected]>
Co-authored-by: Maximilian Roos <[email protected]>
Updated the branch in the hopes of the tests passing. The failures seem unrelated |
Hopefully will nudge bug reports toward making a good MVCE
Anecdotally, I added this to zarr-python a while back, and it's seen a decent bit of use since then.