Skip to content

Commit

Permalink
Merge pull request #195 from stephentyrone/readme-semver-1.0
Browse files Browse the repository at this point in the history
Update README for 1.0.0.
  • Loading branch information
stephentyrone authored Aug 31, 2021
2 parents 79f6025 + b4ec755 commit 1e5cbc4
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,19 @@ To use Swift Numerics in a SwiftPM project:

## Source stability

Swift Numerics uses semantic versioning.
The public API of Swift Numerics is the non-underscored contents of the modules re-exported by the Numerics top-level module.
E.g. the contents of `_NumericsShims` are not considered API, nor is the `_mulAdd` operation defined for `Real` types.
The Swift Numerics package is source stable; version numbers follow [Semantic Versioning](https://semver.org).
The public API of the `swift-numerics` package consists of non-underscored declarations that are marked either `public` or `usableFromInline` in modules re-exported by the top-level `Numerics` module.
Interfaces that aren't part of the public API may continue to change in any release, including patch releases.

Note that contents of the `_NumericsShims` and `_TestSupport` modules, as well as contents of the `Tests` directory, explicitly are not public API.
The definitions therein may therefore change at whim, and the entire module may be removed in any new release.
If you have a use case that requires underscored operations, please raise an issue to request that they be made public API.

Future minor versions of the package may introduce changes to these rules as needed.

We'd like this package to quickly embrace Swift language and toolchain improvements that are relevant to its mandate.
Accordingly, from time to time, we expect that new versions of this package will require clients to upgrade to a more recent Swift toolchain release.
Requiring a new Swift release will only require a minor version bump.

## Contributing to Swift Numerics

Expand Down

0 comments on commit 1e5cbc4

Please sign in to comment.