diff --git a/README.md b/README.md index 4b1fe24..5a5b9cf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ - [Terraform Provider OpenSearch](#Terraform-Provider-OpenSearch) +- [Compatibility](#compatibility) +- [Version and Branching](#version-and-branching) - [Contributing](#contributing) - [Maintainer Responsibilities](MAINTAINERS.md) - [Getting Help](#getting-help) @@ -22,6 +24,15 @@ This provider will target compatibility with major versions of Opensearch, each | 2.x | :x: | +## Version and Branching +As of now, this terraform-provider-opensearch repository maintains 2 branches: +* _main_ (2.x.x OpenSearch development) +* _1.x_ (1.x.x OpenSearch development) + +Contributors should choose the corresponding branch(es) when commiting their change(s): +* If you have a change for a specific version, only open PR to specific branch +* If you have a change for all available versions, first open a PR on `main`, then open a backport PR with `[x]` in the title, with label `backport 1.x`, etc. + ## Contributing See [developer guide](DEVELOPER_GUIDE.md) and [how to contribute to this project](CONTRIBUTING.md).