Doc: Add version rule to avoid surpises #249
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a new section "Release Policy" to give a recommendation. As with the upcoming major 3 release of semver, a lot of things have been changed. To avoid any surprises for our users or even break their code base, a short version restriction can solve that. This should help users who wants to stay with release 2. Basically, it boils down to a line like `semver>=2,<3`. This can be added in any file which lists dependencies.
c519d39 to
028f6b1
Compare
tomschr
added a commit
to tomschr/python-semver
that referenced
this pull request
May 13, 2020
* Update CHANGELOG * Improve release-procedure.md * python-semver#249: Add release policy and version restriction in documentation to help our users which would like to stay on the major 2 release. * python-semver#250: Simplify installation semver on openSUSE with ``obs://``. * python-semver#251: Return type of ``semver.VersionInfo.next_version`` to always return a ``VersionInfo`` instance. * python-semver#256: Made docstrings consistent
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is not based on any specific issue. It's a doc-only addition.
Add a new section "Release Policy" to give a recommendation for users who wants to stay for major release 2.
As with the upcoming major 3 release of semver, a lot of things have been changed. To avoid any surprises for our users or even break their code base, a short version restriction can solve that.
Basically, it boils down to a line like
semver>=2,<3. This can be added in any file which lists dependencies.