Merge pull request #328 from oasisprotocol/pro-wh/feature/rp

docs: change suggested backport branch names
oasisprotocol · Nov 28, 2023 · cfa7f11 · cfa7f11
2 parents f0cb7e4 + 4796a65
commit cfa7f11
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 5 deletions.
diff --git a/.changelog/328.doc.md b/.changelog/328.doc.md
@@ -0,0 +1 @@
+docs: change suggested backport branch names
diff --git a/docs/release-process.md b/docs/release-process.md
@@ -166,11 +166,11 @@ export RELEASE_BRANCH="stable/1.5.x"
 
 ### Back-port Changes
 
-Create a new branch, e.g. `${RELEASE_BRANCH}-backport-foo`, from the
+Create a new branch, e.g. `yourgithubusername/${RELEASE_BRANCH}/foo`, from the
 `${RELEASE_BRANCH}` branch:
 
 ```bash
-git checkout -b ${RELEASE_BRANCH}-backport-foo ${RELEASE_BRANCH}
+git checkout -b yourgithubusername/${RELEASE_BRANCH}/foo ${RELEASE_BRANCH}
 ```
 
 After back-porting all the desired changes, push it to the origin and make a
@@ -182,11 +182,11 @@ As with a regular release, the back-ported changes should include the
 corresponding [Change Log Fragments] that need to be assembled into a new
 section of the [Change Log] using the `changelog` [Make] target.
 
-Create a new branch, e.g. `${RELEASE_BRANCH}-changelog`, from the
-`${RELEASE_BRANCH}` branch:
+Create a new branch, e.g. `yourgithubusername/${RELEASE_BRANCH}/changelog`,
+from the `${RELEASE_BRANCH}` branch:
 
 ```bash
-git checkout -b ${RELEASE_BRANCH}-changelog ${RELEASE_BRANCH}
+git checkout -b yourgithubusername/${RELEASE_BRANCH}/changelog ${RELEASE_BRANCH}
 ```
 
 Then run [Make]'s `changelog` target: