Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REL: officially adopt EffVer #98

Merged
merged 2 commits into from
Jan 16, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
REL: officially adopt EffVer
  • Loading branch information
lucascolley committed Jan 16, 2025
commit 2caa045b31acfa97bf8ed81729538ebe458ced03
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- SPHINX-START -->

Expand All @@ -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
Expand Down
11 changes: 10 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)=

Expand Down
Loading