Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

4.x: Update readmes to clarify use of dev-N.x branches for development #60

Merged
merged 1 commit into from
Jul 17, 2024
Merged

4.x: Update readmes to clarify use of dev-N.x branches for development #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 4 example you would use the `dev-4.x` branch.

## Code of Conduct

Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd
Expand Down
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ mvn clean install

### How Repository is Organized

| Branch | Description |
| ------------- |-------------|
| helidon-4.x | Examples for the current release of Helidon 4 |
| dev-4.x | Development branch for Helidon 4 release currently under development |

| Tags | Description |
| ------------- |-------------|
| N.N.N | Examples for a specific version of Helion |
| 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 | 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 4:

Expand Down