From 2caa045b31acfa97bf8ed81729538ebe458ced03 Mon Sep 17 00:00:00 2001 From: Lucas Colley Date: Thu, 16 Jan 2025 20:02:05 +0000 Subject: [PATCH 1/2] REL: officially adopt EffVer --- README.md | 14 ++++++++++++++ docs/index.md | 11 ++++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3165e70d..92eb21e2 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ [![PyPI version][pypi-version]][pypi-link] [![Conda-Forge][conda-badge]][conda-link] [![PyPI platforms][pypi-platforms]][pypi-link] +[![EffVer Versioning](https://img.shields.io/badge/version_scheme-EffVer-0097a7)](https://jacobtomlinson.dev/effver) @@ -36,6 +37,19 @@ Used by: scientific computing. - _your library? Let us know!_ +## Installation + +See https://data-apis.org/array-api-extra/#installation. + +## Versioning + +This project uses [EffVer](https://jacobtomlinson.dev/effver/). TL;DR: + +- To bump from version `x.y.z` to `x.(y+1).z` of array-api-extra, expect that + you may need to put in some work. +- To bump from version `x.y.z` to `x.y.(z+1)`, any work needed on your side + should be minimal. Please open an issue if this is not the case! + ## Contributors This project exists thanks to the following contributors diff --git a/docs/index.md b/docs/index.md index c1998cdd..84521e97 100644 --- a/docs/index.md +++ b/docs/index.md @@ -112,7 +112,16 @@ See [an example of this in SciPy][scipy-vendor-example]. ``` [scipy-vendor-example]: -https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py + https://github.com/scipy/scipy/blob/main/scipy/_lib/_array_api_compat_vendor.py + +## Versioning + +This project uses [EffVer](https://jacobtomlinson.dev/effver/). TL;DR: + +- To bump from version `x.y.z` to `x.(y+1).z` of array-api-extra, expect that + you may need to put in some work. +- To bump from version `x.y.z` to `x.y.(z+1)`, any work needed on your side + should be minimal. Please open an issue if this is not the case! (usage)= From 6b0020a8976170547f4b6343a05c563047348696 Mon Sep 17 00:00:00 2001 From: Lucas Colley Date: Thu, 16 Jan 2025 20:06:34 +0000 Subject: [PATCH 2/2] tweak version --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 92eb21e2..3ef32b32 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ See https://data-apis.org/array-api-extra/#installation. This project uses [EffVer](https://jacobtomlinson.dev/effver/). TL;DR: -- To bump from version `x.y.z` to `x.(y+1).z` of array-api-extra, expect that +- To bump from version `x.y.z` to `x.(y+1).0` of array-api-extra, expect that you may need to put in some work. - To bump from version `x.y.z` to `x.y.(z+1)`, any work needed on your side should be minimal. Please open an issue if this is not the case! diff --git a/docs/index.md b/docs/index.md index 84521e97..d15a6247 100644 --- a/docs/index.md +++ b/docs/index.md @@ -118,7 +118,7 @@ See [an example of this in SciPy][scipy-vendor-example]. This project uses [EffVer](https://jacobtomlinson.dev/effver/). TL;DR: -- To bump from version `x.y.z` to `x.(y+1).z` of array-api-extra, expect that +- To bump from version `x.y.z` to `x.(y+1).0` of array-api-extra, expect that you may need to put in some work. - To bump from version `x.y.z` to `x.y.(z+1)`, any work needed on your side should be minimal. Please open an issue if this is not the case!