Skip to content

Commit

Permalink
Merge pull request #2066 from christianvogt/branch-naming
Browse files Browse the repository at this point in the history
update branch docs to include merge pr branch naming pattern
  • Loading branch information
openshift-ci[bot] authored Nov 3, 2023
2 parents 37a6b1f + bd6c99a commit 594994c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/process-definition/branches.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ There are really two types of branches.
- Core branches (like `main` and `incubation`)
- [Bot branches](#bot-branches)

Every _new_ commit needs to come from a fork through a PR. We don't allow for pushing new content directly through our flows. New docs file, new code change, and even fixing a typo needs a PR from your fork to get into our repository.
Every _new_ commit needs to come from a fork through a PR. We don't allow for pushing new content directly through our flows. New docs file, new code change, and even fixing a typo needs a PR from your fork to get into our repository. This ensures automated tests pass before the change is merged.

With that said, there are really 3 types of flows that utilize both fork branches and Upstream branches.

Expand All @@ -33,6 +33,10 @@ There is only ever 1 `main` and 1 `incubation` branch. Feature branches start wi

Read more on git tags & releases in our [release documentation].

Understanding the commit history on a branch is important. Therefore when merging a branch into another, your PR branch must follow the pattern `merge-<source branch nam>`.

For example when merging `f/some-feature` into `incubation`, name your branch `merge-f/some-feature`. This will result in a commit message on the `incubation` branch of `Merge pull request # from <username>/merge-f/some-feature` when the PR is merged.

## Main

> aka "The Stable Branch"
Expand Down

0 comments on commit 594994c

Please sign in to comment.