From 482622f4ef7423f8605e3d021b3a035cf2e8c82a Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Thu, 24 Jul 2025 19:47:50 -0400 Subject: [PATCH 1/6] Add pep-723 style script to bug report issue template --- .github/ISSUE_TEMPLATE/bugreport.yml | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index 5bd7efd12f1..7c356bf3002 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -39,6 +39,23 @@ body: - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve) - [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports) + 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. + value: | + ```python + # /// script + # requires-python = ">=3.11" + # dependencies = [ + # "xarray@git+https://github.com/pydata/xarray.git@main", + # ] + # /// + # + # This script automatically imports the development branch of xarray to check for issues + + import xarray as xr + xr.show_versions() + # your reproducer code ... + ``` options: - label: Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray. - label: Complete example — the example is self-contained, including all data and the text of any traceback. From 2fb1f1b48ed06987a89620295fa93274836d6ea2 Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Mon, 8 Sep 2025 11:18:42 -0400 Subject: [PATCH 2/6] make suggestion rather than requirement --- .github/ISSUE_TEMPLATE/bugreport.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index 7c356bf3002..0789021ed8f 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -39,8 +39,9 @@ body: - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve) - [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports) - 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. + Consider listing dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example). + So that put in a file named `issue.py` calling `uv run issue.py` should show the issue. If you do not feel free to delete the suggestion + below. value: | ```python # /// script From c4f1ae686f7074452b00f0d95e5f819ef66dfe02 Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Mon, 8 Sep 2025 12:43:53 -0400 Subject: [PATCH 3/6] Update .github/ISSUE_TEMPLATE/bugreport.yml Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bugreport.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index 0789021ed8f..e0cfe0b52d7 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -40,7 +40,7 @@ body: - [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports) Consider listing dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example). - So that put in a file named `issue.py` calling `uv run issue.py` should show the issue. If you do not feel free to delete the suggestion + So that calling `uv run issue.py` shows the issue when copied into `issue.py`. (not required; alternatively feel free to delete the suggestion) below. value: | ```python From 9814c44b907b9f8cf55812b5e438f35a351d387b Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Mon, 8 Sep 2025 14:37:40 -0400 Subject: [PATCH 4/6] use complete --- .github/ISSUE_TEMPLATE/bugreport.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index e0cfe0b52d7..0606d29614a 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -47,7 +47,7 @@ body: # /// script # requires-python = ">=3.11" # dependencies = [ - # "xarray@git+https://github.com/pydata/xarray.git@main", + # "xarray[complete]@git+https://github.com/pydata/xarray.git@main, # ] # /// # From a529703527ce1bb111aa2ffbf60c9062e47cf91a Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Mon, 8 Sep 2025 15:54:15 -0400 Subject: [PATCH 5/6] Update .github/ISSUE_TEMPLATE/bugreport.yml Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bugreport.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index 0606d29614a..e8bdaa6603c 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -39,7 +39,7 @@ body: - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve) - [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports) - Consider listing dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example). + Consider listing additional or specific dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example). So that calling `uv run issue.py` shows the issue when copied into `issue.py`. (not required; alternatively feel free to delete the suggestion) below. value: | From 000720af7a9daa05ae93590cb03f6d3651913d11 Mon Sep 17 00:00:00 2001 From: Ian Hunt-Isaak Date: Tue, 9 Sep 2025 14:42:19 -0400 Subject: [PATCH 6/6] Update .github/ISSUE_TEMPLATE/bugreport.yml Co-authored-by: Maximilian Roos <5635139+max-sixty@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bugreport.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bugreport.yml b/.github/ISSUE_TEMPLATE/bugreport.yml index e8bdaa6603c..dca031aca78 100644 --- a/.github/ISSUE_TEMPLATE/bugreport.yml +++ b/.github/ISSUE_TEMPLATE/bugreport.yml @@ -39,9 +39,8 @@ body: - [Minimal Complete Verifiable Examples](https://stackoverflow.com/help/mcve) - [Craft Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports) - Consider listing additional or specific dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example). - So that calling `uv run issue.py` shows the issue when copied into `issue.py`. (not required; alternatively feel free to delete the suggestion) - below. + Consider listing additional or specific dependencies in [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#example) + so that calling `uv run issue.py` shows the issue when copied into `issue.py`. (not strictly required) value: | ```python # /// script