From bd6c99a579fff7415c24c4100d1c643d3d70ee3d Mon Sep 17 00:00:00 2001 From: Christian Vogt Date: Fri, 3 Nov 2023 13:31:34 -0400 Subject: [PATCH] update branch docs to include merge pr branch naming pattern --- docs/process-definition/branches.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/process-definition/branches.md b/docs/process-definition/branches.md index 889edfb78f..c9d7d2e45d 100644 --- a/docs/process-definition/branches.md +++ b/docs/process-definition/branches.md @@ -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. @@ -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-`. + +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 /merge-f/some-feature` when the PR is merged. + ## Main > aka "The Stable Branch"