Skip to content

Commit

Permalink
Update readme & contributing guide to add versioning (#2544)
Browse files Browse the repository at this point in the history
Co-authored-by: gpanshu <[email protected]>
  • Loading branch information
sdhuka and gpanshu authored Aug 24, 2023
1 parent 70b6533 commit aac074a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ contribution.
- [Test changes to CodeBuild build definitions](#test-changes-to-codebuild-build-definitions)
- [Reporting Bugs/Feature Requests](#reporting-bugsfeature-requests)
- [Contributing via Pull Requests](#contributing-via-pull-requests)
- [Semantic Versioning](#semantic-versioning)
- [Troubleshooting](#troubleshooting)
- [Environment Debugging](#environment-debugging)
- [Problems with the Build](#problems-with-the-build)
Expand Down Expand Up @@ -455,6 +456,19 @@ will run all build tasks (Checkstyle, Lint, unit tests).
- Make sure to update the PR title/description if things change.
- Rebase with the `main` branch if it has commits ahead of your fork.

### Semantic versioning

We follow [semantic versioning](https://semver.org/) for our releases.

#### Semantic versioning and enumeration cases

When Amplify adds a new a new enumeration class entry or sealed class subtype, we
will publish a new **minor** version of the library.

Applications that use a `when` expression to evaluate all members of an enumerated
type can add an `else` branch to prevent new cases from causing compile warnings
or errors.

## Troubleshooting

### Environment Debugging
Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,19 @@ Amplify's default interface renders results through async callbacks. We also pro
- [Using RxJava with Amplify](https://docs.amplify.aws/lib/project-setup/rxjava/q/platform/android)
- [Kotlin Coroutines Support](https://docs.amplify.aws/lib/project-setup/coroutines/q/platform/android)

### Semantic versioning

We follow [semantic versioning](https://semver.org/) for our releases.

#### Semantic versioning and enumeration cases

When Amplify adds a new a new enumeration class entry or sealed class subtype, we
will publish a new **minor** version of the library.

Applications that use a `when` expression to evaluate all members of an enumerated
type can add an `else` branch to prevent new cases from causing compile warnings
or errors.

## License

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

0 comments on commit aac074a

Please sign in to comment.