Skip to content
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
Thank you for opening a PR! Please take the time to fill in the details below.
-->

## Target branch

<!--
This repository uses a main/dev branching model. Please confirm that
your PR targets the correct branch:

- `dev`: all development work (features, docs, dependency updates, etc.)
- `release-x.y`: bug fixes for a specific supported release

Do not target `main` directly; maintainers manage it via merges and cherry-picks.
-->

- [ ] I have verified this PR targets the correct branch (see [branching strategy](https://github.com/redhat-developer/rhdh-local/blob/HEAD/docs/rhdh-local-guide/help-and-contrib.md#branching-model))

## Description
<!--
Please explain the changes you made here.
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,13 @@ To report issues against this repository, please use [JIRA](https://issues.redha

To browse the existing issues, you can use this [Query](https://issues.redhat.com/issues/?filter=-4&jql=project%20%3D%20%22Red%20Hat%20Internal%20Developer%20Platform%22%20%20AND%20component%20%3D%20%22RHDH%20Local%22%20AND%20resolution%20%3D%20Unresolved%20ORDER%20BY%20status%2C%20priority%2C%20updated%20%20%20%20DESC).

Contributions are welcome!
Contributions are welcome! This repository uses a `main`/`dev` branching model:

- **`main`** (default branch) tracks the latest stable GA release of RHDH. Maintainers manage this branch; do not target PRs to `main` directly.
- **`dev`** tracks the upcoming RHDH release (`next` tag). All development PRs should target `dev`.
- **`release-x.y`** branches are used for release stabilization and bug fixes for a specific supported release.

See the [built-in Contributing guide](./docs/rhdh-local-guide/help-and-contrib.md) for details.


## Breaking changes and known issues
Expand Down
26 changes: 24 additions & 2 deletions docs/rhdh-local-guide/help-and-contrib.md

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd consider creating an AGENTS.md (and CLAUDE.md with linked @AGENTS.md) file to specify this explicitly for AI tools. They should read the docs and README too, but they don't always keep it in context.

@rm3l rm3l Aug 4, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point. An AGENTS.md file is being added in this other PR: #255
I can make sure to mention this in that PR. Does that make sense?

@zdrapela zdrapela Aug 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, can be 👍

Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,27 @@ We actively encourage contributions of all types! Here's how you can help:
- **Create example setups** for specific scenarios
- **Document best practices** from real-world usage

### Branching Model

This repository uses a `main`/`dev` branching model to separate stable content from active development:

| Branch | Purpose | Tracks |
|---|---|---|
| **`main`** (default) | Latest stable GA release of RHDH | Current GA RHDH version |
| **`dev`** | Active development for the upcoming RHDH release | RHDH `next` tag |
| **`release-x.y`** | Release stabilization and patch releases | Specific RHDH version |

#### Which branch should my PR target?

| Change type | Target branch |
|---|---|
| All development work (features, docs, dependency updates, etc.) | `dev` |
| Bug fixes for a specific supported release | `release-x.y` |

Do not target `main` directly. Maintainers manage `main` via merges and cherry-picks.

At Feature Freeze, a `release-x.y` branch is created from `dev` for stabilization. At GA, the release branch is merged into `main`, so `main` always reflects the latest stable RHDH release. Maintainers cherry-pick changes to `main` when appropriate (e.g., version-independent fixes that should not wait until the next GA).

### Contribution Workflow

#### 1. Prepare Your Environment
Expand All @@ -106,9 +127,10 @@ git clone https://github.com/YOUR-USERNAME/rhdh-local.git && cd rhdh-local

# Add upstream remote for staying current
git remote add upstream https://github.com/redhat-developer/rhdh-local.git
Comment thread
rm3l marked this conversation as resolved.
git fetch upstream

# Create a development branch
git checkout -b feature/my-contribution
# Create a branch from dev (see "Which branch should my PR target?" above)
git checkout -b feature/my-contribution upstream/dev
```

#### 2. Development Guidelines
Expand Down
3 changes: 3 additions & 0 deletions renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,8 @@
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:recommended"
],
"baseBranches": [
"dev"
]
}