Skip to content

Conversation

@ianhi
Copy link
Contributor

@ianhi ianhi commented Sep 5, 2025

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.

@github-actions github-actions bot added the Automation Github bots, testing workflows, release automation label Sep 5, 2025
@max-sixty
Copy link
Collaborator

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?

Comment on lines 42 to 43
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.
Copy link
Member

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.

Copy link
Contributor Author

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.

@shoyer
Copy link
Member

shoyer commented Sep 8, 2025

This is definitely a nice nudge, but it won't be feasible for everyone, so I would suggest making the ask a little weaker.

@ianhi
Copy link
Contributor Author

ianhi commented Sep 8, 2025

I changed the language to make it more ok to ignore the inline metadata, and said that its explicitly ok to not use it

I would vote to have this as "suggested" for a month before turning it on as required, to assess how it goes?

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

@max-sixty
Copy link
Collaborator

Do you mean to have it as the grayed-out suggestion text?

I just meant "suggested" colloquially — similar to the others' feedback re "Consider" etc

@max-sixty max-sixty enabled auto-merge (squash) September 9, 2025 19:29
@ianhi
Copy link
Contributor Author

ianhi commented Sep 10, 2025

Updated the branch in the hopes of the tests passing. The failures seem unrelated

@max-sixty max-sixty merged commit dff84af into pydata:main Sep 10, 2025
36 checks passed
@ianhi ianhi deleted the pep-723-issues branch September 10, 2025 20:15
@gronniger gronniger mentioned this pull request Sep 15, 2025
shoyer pushed a commit to shoyer/xarray that referenced this pull request Sep 16, 2025
* Add pep-723 style script to bug report issue template

* make suggestion rather than requirement

* Update .github/ISSUE_TEMPLATE/bugreport.yml

Co-authored-by: Maximilian Roos <[email protected]>

* use complete

* Update .github/ISSUE_TEMPLATE/bugreport.yml

Co-authored-by: Maximilian Roos <[email protected]>

* Update .github/ISSUE_TEMPLATE/bugreport.yml

Co-authored-by: Maximilian Roos <[email protected]>

---------

Co-authored-by: Maximilian Roos <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Automation Github bots, testing workflows, release automation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants