-
Notifications
You must be signed in to change notification settings - Fork 14
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
Changes to the EconomyAPIVersion #46
Comments
Great idea.
I agree. Although I am unsure whether we should have the minor version (third digit).
I think Java automatically orders the constants by the hierarchy in which they are defined in the code with their own index or something like that.
We could solve this by linking to a changelog file, better than storing it in the code :) |
In semantic versioning, third digit is patch. I think API versioning should be major/minor only - Major would be breaking changes, minor would be new, non-breaking features. Though it is possible, particularly with the continuously blurring lines between interfaces and implementations, patches for bugfixes should largely just be on the plugin end. That is, however, a reason for multiple repos - with multiple modules, it doesn't make sense to increment the API's version in maven for a purely plugin-side patch. If the API needs a change, certainly, but otherwise it's just a hassle for developers - they'll have to check each update for compatibility when they could just follow the API for changes instead. It feels weird (to me at least, it's certainly done) to have multiple separate projects in one combined repo.
Correct, |
You're right. Maybe adding a new enum entry every time a bug is solved is a bit overkill
That's my problem, letting the order in whitch the entryes are declarated decide what version is newer feels too weak.
Probably better |
Right now the EconomyAPIVersion class is really simple: Identifyes mayor versions with a number, not more not less. I think this should change. I propose some changes
@since
tag, instead of@since v1.0.0
we could use@since {@link me.lokka30.treasury.api.economy.misc.EconomyAPIVersion#VERSION_1 v1.0.0}
in the documentation shows the same but it provides a link to the enum versionVERSION_1
we could usev1_0_0
Comparable<>
interface with the default logic being indexes. Since this logic doesn't necesarily apply to us it would make sense to specify out comparing logicI can make a class with this features so you see what I mean
The text was updated successfully, but these errors were encountered: