Skip to content

Conversation

@ianhi
Copy link
Contributor

@ianhi ianhi commented Dec 12, 2025

PR summary

Closes: #30584
Adds inline script metadata pointing at nightly wheels (or normal pypi if using a non-uv script runner). I've added this in xarray and zarr and in both places a decent portion of bug reports seem to use it. When there it make it easier to make a true reproducible example, and also easier for other to replicate (just copy and then uv run or use my script-bisect

PR checklist

@timhoffm
Copy link
Member

I'm not sure whether this is too complicated for the average bug reporter. I suppose they don't necessarily know about inline script metadata and may or may not know uv. Careful wording is extremely important. - Ideally also in a way that triggers AI to fill in the information but does not put off users redading the issue template manually.

Also, do we want users to point to nightly? That's an additional conceptual step. First, users experience the bug in their installation, most likely a release. Is it ok to report the bug on that release version? Or do we want users to reproduce the bug on the newest release/nightly. So far we do not have such a requirement, and I think it's ok that way. Using a release very much simplifies the script metadata. And I think it's bearable for us to change the version ourselves when investigating the report.

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.

[MNT]: Add PEP-723 metadata to bug report template

2 participants