diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 73a24f49..49bf2d53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,12 +42,19 @@ can be accepted. you intend to submit. 1. Fork this repository 1. Create a branch in your fork to implement the changes. We recommend using - the issue number as part of your branch name, e.g. `1234-fixes` + the issue number as part of your branch name, e.g. `1234-fixes`. Make sure to + base your branch off of the corresponding `dev-N.x` branch (where N is the + major Helidon version). 1. Submit the pull request. *Do not leave the pull request blank*. Explain exactly what your changes are meant to do and provide simple steps on how to validate - your changes. Ensure that you reference the issue you created as well. + your changes. Ensure that you reference the issue you created as well. Target + your PR to the corresponding `dev-N.x` branch. 1. We will assign the pull request for review and running of PR validation workflow before it is merged. +Development work for examples is performed in the `dev-N.x` branches (where +`N` corresponds to a Helidon major version). For example, to make a change to +a Helidon 3 example you would use the `dev-3.x` branch. + ## Code of Conduct Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd diff --git a/README.md b/README.md index ebc85642..816d414d 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,6 @@ Examples for Helidon 3. -[Helidon 4 Examples](https://github.com/helidon-io/helidon/tree/main/examples) and [Helidon 2 Examples](https://github.com/helidon-io/helidon/tree/helidon-2.x/examples) are in the primary Helidon repository. - ## How to Run To build and run Helidon 3 examples you need: @@ -23,14 +21,14 @@ mvn clean install ### How Repository is Organized -| Branch | Description | -| ------------- |-------------| -| helidon-3.x | Examples for the current release of Helidon 3 | -| dev-3.x | Development branch for Helidon 3 release currently under development | +| Branch | Used By | Modified By | Description | +| ----------- |------------|------------------|--------------------------------------------------| +| helidon-N.x | Customers | Release workflow | Latest examples for major version N of Helidon | +| dev-N.x | Developers | PRs | Examples under development for major version N of Helidon | -| Tags | Description | -| ------------- |-------------| -| N.N.N | Examples for a specific version of Helion | +| Tags | Used By | Created By | Description | +|-------|------------|------------------|-----------------------------------------------------| +| N.N.N | Customers | Release workflow | Released examples for a specific version of Helidon | To checkout examples for the most recent release of Helidon 3: