Skip to content

Commit a749f3e

Browse files
stainless-botRobertCraigie
authored andcommitted
docs(readme): remove beta status + document versioning policy (#54)
1 parent 39d2f3f commit a749f3e

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -268,10 +268,15 @@ See the httpx documentation for information about the [`proxies`](https://www.py
268268

269269
By default we will close the underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__) is called but you can also manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
270270

271-
## Status
271+
## Versioning
272272

273-
This package is in beta. Its internals and interfaces are not stable and subject to change without a major semver bump;
274-
please reach out if you rely on any undocumented behavior.
273+
This package generally attempts to follow [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
274+
275+
1. Changes that only affect static types, without breaking runtime behavior.
276+
2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
277+
3. Changes that we do not expect to impact the vast majority of users in practice.
278+
279+
We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
275280

276281
We are keen for your feedback; please open an [issue](https://www.github.com/Finch-API/finch-api-python/issues) with questions, bugs, or suggestions.
277282

0 commit comments

Comments
 (0)