-
Notifications
You must be signed in to change notification settings - Fork 63
docs: Add versioning file #224
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
Merged
Merged
Changes from 2 commits
Commits
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Versioning Policy | ||
|
||
The AWS Encryption SDK for JavaScript versioning follows [semantic versioning][link-semver] standards. | ||
|
||
## Major versions | ||
|
||
Major version changes are significant and expected to break backwards compatibility. | ||
|
||
## Minor versions | ||
|
||
Minor version changes will not break compatibility between the previous minor versions; | ||
to do so is a bug. | ||
Encryption SDK changes will also involve addition of optional features, and non-breaking enhancements. | ||
Additionally any change to the version of a dependency. | ||
|
||
## Patch versions | ||
|
||
Patch versions changes are meant only for bug fixes, | ||
and will not break compatibility of the current major version. | ||
A patch release will contain a collection of minor bug fixes, | ||
or individual major and security bug fixes, depending on severity. | ||
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. | ||
|
||
# Semantic Commits | ||
|
||
We seek to increase clarity at all levels of the update and releases process. | ||
We require pull requests adhere to the [Conventional Commits][conventional-commits] spec, | ||
lizroth marked this conversation as resolved.
Show resolved
Hide resolved
|
||
which can be summarized as follows: | ||
|
||
* Commits that would result in a semver **major** bump must start with `BREAKING CHANGE:`. | ||
* Commits that would result in a semver **minor** bump must start with `feat:`. | ||
* Commits that would result in a semver **patch** bump must start with `fix:`. | ||
|
||
* We allow squashing of commits, | ||
provided that the squashed message adheres the the above message format. | ||
|
||
* It is acceptable for some commits in a pull request to not include a semantic prefix, | ||
as long as a later commit in the same pull request contains a meaningful encompassing semantic message. | ||
|
||
[link-semver]:https://semver.org/ | ||
[conventional-commits]: https://conventionalcommits.org/ |
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.
Uh oh!
There was an error while loading. Please reload this page.