-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
add bin compat goal #1897
Merged
Merged
add bin compat goal #1897
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -154,6 +154,33 @@ into larger problems. | |
If you are being harassed, please contact one of [us](#maintainers) | ||
immediately so that we can support you. | ||
|
||
### Binary compatibility and versioning | ||
|
||
After `1.0.0` release, we [decided](https://github.com/typelevel/cats/issues/1233) | ||
to use *MAJOR.MINOR.PATCH* [Semantic Versioning 2.0.0](http://semver.org/) | ||
going forward, which is different from the *EPIC.MAJOR.MINOR* schema commonly in | ||
Java and Scala libraries (including the Scala lang). | ||
|
||
Cats' strives to provide a solid and stable foundation for an ecosystem of | ||
FP libraries. Thus, we treat maintaining binary compatibility with a high priority. | ||
In semantic versioning, breaking change is **ONLY** allowed between *MAJOR* versions. | ||
We will maintain backward binary compatibility between *PATCH* AND *MINOR* versions. | ||
For example, when we release cats `1.1.0`, it will be backward binary compatible | ||
with the previous `1.0.x` versions. I.E. the new JAR will be a drop-in replacement for | ||
the old one. This is critical when your application has a diamond | ||
dependency on cats - depending on two (or more) libraries that both depend on cats. | ||
If one library upgrades to the new `1.1.0` cats before the other one does, your | ||
application still runs thanks to this backward binary compatibility. | ||
|
||
Also worth noting is that according to semantic versioning, | ||
*MINOR* version Y (x.Y.z | x > 0) MUST be incremented | ||
if new, backwards compatible functionality is introduced to the public API. | ||
It MUST be incremented if any public API functionality is marked as deprecated. | ||
|
||
Any binary breaking changes will require a *MAJOR* version bump, which we will be very | ||
cautious about. We will also consider using `organization` and package name for major | ||
versioning in the future. But that decision is yet to be made. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👍 Thanks for this inclusion. |
||
|
||
### Maintainers | ||
|
||
The current maintainers (people who can merge pull requests) are: | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
EPIC -> EPOCH ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks! corrected.