8000 docs(readme): reordered content (#1343) · targhs/sentry-python@91b0387 · GitHub
[go: up one dir, main page]

Skip to content

Commit 91b0387

Browse files
authored
docs(readme): reordered content (getsentry#1343)
1 parent 3b17b68 commit 91b0387

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,26 +16,6 @@ This is the official Python SDK for [Sentry](http://sentry.io/)
1616

1717
---
1818

19-
## Versioning Policy
20-
21-
This project follows [semver](https://semver.org/), with three additions:
22-
23-
- Semver says that major version `0` can include breaking changes at any time. Still, it is common practice to assume that only `0.x` releases (minor versions) can contain breaking changes while `0.x.y` releases (patch versions) are used for backwards-compatible changes (bugfixes and features). This project also follows that practice.
24-
25-
- All undocumented APIs are considered internal. They are not part of this contract.
26-
27-
- Certain features (e.g. integrations) may be explicitly called out as "experimental" or "unstable" in the documentation. They come with their own versioning policy described in the documentation.
28-
29-
We recommend to pin your version requirements against `1.x.*` or `1.x.y`.
30-
Either one of the following is fine:
31-
32-
```
33-
sentry-sdk>=1.0.0,<2.0.0
34-
sentry-sdk==1.5.0
35-
```
36-
37-
A major release `N` implies the previous release `N-1` will no longer receive updates. We generally do not backport bugfixes to older versions unless they are security relevant. However, feel free to ask for backports of specific commits on the bugtracker.
38-
3919
## Migrate From sentry-raven
4020

4121
The old `raven-python` client has entered maintenance mode and was moved [here](https://github.com/getsentry/raven-python).
@@ -110,6 +90,26 @@ Please refer to [CONTRIBUTING.md](CONTRIBUTING.md).
11090

11191
If you need help setting up or configuring the Python SDK (or anything else in the Sentry universe) please head over to the [Sentry Community on Discord](https://discord.com/invite/Ww9hbqr). There is a ton of great people in our Discord community ready to help you!
11292

93+
## Versioning Policy
94+
95+
This project follows [semver](https://semver.org/), with three additions:
96+
97+
- Semver says that major version `0` can include breaking changes at any time. Still, it is common practice to assume that only `0.x` releases (minor versions) can contain breaking changes while `0.x.y` releases (patch versions) are used for backwards-compatible changes (bugfixes and features). This project also follows that practice.
98+
99+
- All undocumented APIs are considered internal. They are not part of this contract.
100+
101+
- Certain features (e.g. integrations) may be explicitly called out as "experimental" or "unstable" in the documentation. They come with their own versioning policy described in the documentation.
102+
103+
We recommend to pin your version requirements against `1.x.*` or `1.x.y`.
104+
Either one of the following is fine:
105+
106+
```
107+
sentry-sdk>=1.0.0,<2.0.0
108+
sentry-sdk==1.5.0
109+
```
110+
111+
A major release `N` implies the previous release `N-1` will no longer receive updates. We generally do not backport bugfixes to older versions unless they are security relevant. However, feel free to ask for backports of specific commits on the bugtracker.
112+
113113
## Resources
114114

115115
- [![Documentation](https://img.shields.io/badge/documentation-sentry.io-green.svg)](https://docs.sentry.io/quickstart/)

0 commit comments

Comments
 (0)
0