Skip to content

Commit 14067c8

Browse files
authored
chore: Updating README.md and CONTRIBUTING.md to include details about semantic versioning (#3112)
* chore: Updating README.md and CONTRIBUTING.md to include details about semantic versioning * updating contribution.md to update legend list
1 parent 2855d22 commit 14067c8

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Thank you for your interest in contributing to our project! <3 Whether it's a bu
44

55
- [History & Ethos](#our-history-and-ethos)
66
- [Our Design](#our-design)
7+
- [Semantic versioning](#semantic-versioning)
8+
- [Semantic versioning and enumeration cases](#semantic-versioning-and-enumeration-cases)
79
- [Getting Started](#getting-started)
810
- [Testing](#testing)
911
- [Tools](#tools)
@@ -27,6 +29,17 @@ Thank you for your interest in contributing to our project! <3 Whether it's a bu
2729

2830
For a brief history and our ethos/design philosophy around the Amplify project please refer to this [document](/ETHOS.md).
2931

32+
## Semantic versioning
33+
34+
We follow [semantic versioning](https://semver.org/) for our releases.
35+
36+
### Semantic versioning and enumeration cases
37+
38+
When Amplify adds a new enumeration value, we will publish a new **minor** version
39+
of the library.
40+
41+
Applications that evaluate all members of an enumeration using a `switch` statement can add a `default` case to prevent new cases from causing compile warnings or errors.
42+
3043
## Getting Started
3144

3245
To get started with the Amplify Library for Swift, first make sure you have Xcode 13.4 or later installed.

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ The Amplify Library for Swift is layered on the [AWS SDK for Swift](https://aws.
3737
> To use Amplify Swift with visionOS, you'll need to target the `visionos-preview` branch.
3838
> For more information, see [Platform Support](https://github.com/aws-amplify/amplify-swift/tree/visionos-preview#platform-support) on the `visionos-preview` branch.
3939
40+
## Semantic versioning
41+
42+
We follow [semantic versioning](https://semver.org/) for our releases.
43+
44+
### Semantic versioning and enumeration cases
45+
46+
When Amplify adds a new enumeration value, we will publish a new **minor** version
47+
of the library.
48+
49+
Applications that evaluate all members of an enumeration using a `switch` statement can add a `default` case to prevent new cases from causing compile warnings or errors.
50+
4051
## License
4152

4253
This library is licensed under the Apache 2.0 License.

0 commit comments

Comments
 (0)