|
| 1 | +# Versioning Policy |
| 2 | + |
| 3 | +The AWS Encryption SDK for JavaScript versioning follows [semantic versioning][link-semver] standards. |
| 4 | + |
| 5 | +## Major versions |
| 6 | + |
| 7 | +Major version changes are significant and expected to break backwards compatibility. |
| 8 | + |
| 9 | +## Minor versions |
| 10 | + |
| 11 | +Minor version changes will not break compatibility between the previous minor versions; |
| 12 | +to do so is a bug. |
| 13 | +Encryption SDK changes will also involve addition of optional features, and non-breaking enhancements. |
| 14 | +Additionally, any change to the version of a dependency is a minor version change. |
| 15 | + |
| 16 | +## Patch versions |
| 17 | + |
| 18 | +Patch versions changes are meant only for bug fixes, |
| 19 | +and will not break compatibility of the current major version. |
| 20 | +A patch release will contain a collection of minor bug fixes, |
| 21 | +or individual major and security bug fixes, depending on severity. |
| 22 | + |
| 23 | +# Semantic Commits |
| 24 | + |
| 25 | +We seek to increase clarity at all levels of the update and releases process. |
| 26 | +We require pull requests adhere to the [Conventional Commits][conventional-commits] spec, |
| 27 | +which can be summarized as follows: |
| 28 | + |
| 29 | +* Commits that would result in a semver **major** bump must start with `BREAKING CHANGE:`. |
| 30 | +* Commits that would result in a semver **minor** bump must start with `feat:`. |
| 31 | +* Commits that would result in a semver **patch** bump must start with `fix:`. |
| 32 | + |
| 33 | +* We allow squashing of commits, |
| 34 | + provided that the squashed message adheres the the above message format. |
| 35 | + |
| 36 | +* It is acceptable for some commits in a pull request to not include a semantic prefix, |
| 37 | + as long as a later commit in the same pull request contains a meaningful encompassing semantic message. |
| 38 | + |
| 39 | +[link-semver]:https://semver.org/ |
| 40 | +[conventional-commits]: https://conventionalcommits.org/ |
0 commit comments