From ef8acd82290f184134cee77f20380aad1dc406eb Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Wed, 6 Nov 2024 17:19:36 +0000 Subject: [PATCH 1/4] Document that we conform to SPEC0 version support. (Finally) closes #362 as per the definition of done in David's last comment. --- CONTRIBUTING.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b5e5cdc..73a2de6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,6 +53,16 @@ cookiecutter /path/to/your/checkout/of/python-tooling --checkout You can omit the `--checkout` option if you're already on the branch you want to test. + +#### Python version support + +[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) + +We follow Scientific Python's [SPEC0](https://scientific-python.org/specs/spec-0000/) policy. +Notably this means our template will support [Python versions for three years after their release](https://scientific-python.org/specs/spec-0000/#support-window), and changes to the template are equired to pass tests in all such python versions. +(See [the CI checks](./.github/workflows/test.yml) for precise details.) + + ### Developing the recommended tooling pages Pages all live in the `docs/pages` sub-directory, and are written in markdown. From 420eadb2ba0db90906e126203cdd40ef2d96d892 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 6 Nov 2024 17:20:47 +0000 Subject: [PATCH 2/4] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- CONTRIBUTING.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73a2de6b..5ec0b1b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,6 @@ cookiecutter /path/to/your/checkout/of/python-tooling --checkout You can omit the `--checkout` option if you're already on the branch you want to test. - #### Python version support [![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) @@ -62,7 +61,6 @@ We follow Scientific Python's [SPEC0](https://scientific-python.org/specs/spec-0 Notably this means our template will support [Python versions for three years after their release](https://scientific-python.org/specs/spec-0000/#support-window), and changes to the template are equired to pass tests in all such python versions. (See [the CI checks](./.github/workflows/test.yml) for precise details.) - ### Developing the recommended tooling pages Pages all live in the `docs/pages` sub-directory, and are written in markdown. From b0cf8233a411143d52ff8eb3c6f931486e33f5fa Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Wed, 6 Nov 2024 17:59:08 +0000 Subject: [PATCH 3/4] Typo. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ec0b1b6..df921d38 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,7 +58,7 @@ branch you want to test. [![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) We follow Scientific Python's [SPEC0](https://scientific-python.org/specs/spec-0000/) policy. -Notably this means our template will support [Python versions for three years after their release](https://scientific-python.org/specs/spec-0000/#support-window), and changes to the template are equired to pass tests in all such python versions. +Notably this means our template will support [Python versions for three years after their release](https://scientific-python.org/specs/spec-0000/#support-window), and changes to the template are required to pass tests in all such python versions. (See [the CI checks](./.github/workflows/test.yml) for precise details.) ### Developing the recommended tooling pages From 8eb01e7880a444f3a1f0b12cd3a95f13e531b7e5 Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Wed, 6 Nov 2024 18:00:33 +0000 Subject: [PATCH 4/4] Write SPEC how they write SPECs. Co-authored-by: David Stansby --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df921d38..650dc5af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -57,7 +57,7 @@ branch you want to test. [![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/) -We follow Scientific Python's [SPEC0](https://scientific-python.org/specs/spec-0000/) policy. +We follow Scientific Python's [SPEC 0](https://scientific-python.org/specs/spec-0000/) policy. Notably this means our template will support [Python versions for three years after their release](https://scientific-python.org/specs/spec-0000/#support-window), and changes to the template are required to pass tests in all such python versions. (See [the CI checks](./.github/workflows/test.yml) for precise details.)