docs: Add versioning file #224
Conversation
There was a problem hiding this comment.
I'd also like @SalusaSecondus to take a look at this.
I like this direction, but he had thoughts on our versioning policies elsewhere.
VERSIONING.md
Outdated
| What this means for you | ||
| ======================= |
There was a problem hiding this comment.
Needs markdown-style heading notation.
There was a problem hiding this comment.
I would like our versioning policies to be consistent across all of our libraries. I don't think this is different enough to warrant show stopping at this time. Conventional Commits seem very compelling to me.
I found a minor words thing, but otherwise I am happy enough with this to Approve.
Merging should wait for @SalusaSecondus and any follow-up thoughts @mattsb42-aws has now that the Markdownization is done. :)
|
VERSIONING.md
Outdated
| A patch release will also include warning of upcoming breaking changes, whenever possible. | ||
|
|
||
| # What this means for you | ||
|
|
||
| We recommend running the most recent version. Here are our suggestions for managing updates: | ||
|
|
||
| * X changes will require some effort to incorporate. | ||
| * Y changes will not require significant effort to incorporate. | ||
|
|
||
| * If you have good unit and integration tests, these changes are generally safe to pick up automatically. | ||
|
|
||
| * Z changes will not require any changes to your code. Z changes are intended to be picked up automatically. | ||
|
|
||
| * Good unit and integration tests are always recommended. | ||
|
|
There was a problem hiding this comment.
I think we could have left these as expressions of our intent (especially the bit about if we know we will need to make breaking changes soon, we will make an effort to warn you), but I don't think removing them is a problem either, given that we're stating our use of CC/SemVer.
|
To be clear. My concerns aside, I have no objections to us moving forward with this proposed versioning scheme. |
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
Check any applicable: