Skip to content

Commit aac074a

Browse files
sdhukagpanshu
andauthored
Update readme & contributing guide to add versioning (#2544)
Co-authored-by: gpanshu <[email protected]>
1 parent 70b6533 commit aac074a

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

CONTRIBUTING.md

+14
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ contribution.
2121
- [Test changes to CodeBuild build definitions](#test-changes-to-codebuild-build-definitions)
2222
- [Reporting Bugs/Feature Requests](#reporting-bugsfeature-requests)
2323
- [Contributing via Pull Requests](#contributing-via-pull-requests)
24+
- [Semantic Versioning](#semantic-versioning)
2425
- [Troubleshooting](#troubleshooting)
2526
- [Environment Debugging](#environment-debugging)
2627
- [Problems with the Build](#problems-with-the-build)
@@ -455,6 +456,19 @@ will run all build tasks (Checkstyle, Lint, unit tests).
455456
- Make sure to update the PR title/description if things change.
456457
- Rebase with the `main` branch if it has commits ahead of your fork.
457458

459+
### Semantic versioning
460+
461+
We follow [semantic versioning](https://semver.org/) for our releases.
462+
463+
#### Semantic versioning and enumeration cases
464+
465+
When Amplify adds a new a new enumeration class entry or sealed class subtype, we
466+
will publish a new **minor** version of the library.
467+
468+
Applications that use a `when` expression to evaluate all members of an enumerated
469+
type can add an `else` branch to prevent new cases from causing compile warnings
470+
or errors.
471+
458472
## Troubleshooting
459473

460474
### Environment Debugging

README.md

+13
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,19 @@ Amplify's default interface renders results through async callbacks. We also pro
112112
- [Using RxJava with Amplify](https://docs.amplify.aws/lib/project-setup/rxjava/q/platform/android)
113113
- [Kotlin Coroutines Support](https://docs.amplify.aws/lib/project-setup/coroutines/q/platform/android)
114114

115+
### Semantic versioning
116+
117+
We follow [semantic versioning](https://semver.org/) for our releases.
118+
119+
#### Semantic versioning and enumeration cases
120+
121+
When Amplify adds a new a new enumeration class entry or sealed class subtype, we
122+
will publish a new **minor** version of the library.
123+
124+
Applications that use a `when` expression to evaluate all members of an enumerated
125+
type can add an `else` branch to prevent new cases from causing compile warnings
126+
or errors.
127+
115128
## License
116129

117130
This library is licensed under the [Apache 2.0 License](./LICENSE).

0 commit comments

Comments
 (0)