From 5ce159a5f3acde276a8658197d844c69910eeecb Mon Sep 17 00:00:00 2001 From: Adam Glustein Date: Wed, 17 Jul 2024 16:35:51 -0400 Subject: [PATCH] Fix maintainer instructions for checking out PRs Signed-off-by: Adam Glustein --- docs/wiki/dev-guides/GitHub-Conventions.md | 8 ++++---- docs/wiki/dev-guides/Release-Process.md | 10 +++++----- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/wiki/dev-guides/GitHub-Conventions.md b/docs/wiki/dev-guides/GitHub-Conventions.md index a60d64530..f68927648 100644 --- a/docs/wiki/dev-guides/GitHub-Conventions.md +++ b/docs/wiki/dev-guides/GitHub-Conventions.md @@ -34,10 +34,10 @@ docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/ 1. Fetch the pull request ref and assign it to a local branch name. ```bash - git fetch upstream pull//HEAD/:LOCAL_BRANCH_NAME + git fetch pull//head:LOCAL_BRANCH_NAME ``` - where `` is the PR ID number and `LOCAL_BRANCH_NAME` is a name + where `` is the remote (usually `origin`), `` is the PR ID number and `LOCAL_BRANCH_NAME` is a name chosen for the PR branch in your local checkout of CSP. 1. Switch to the PR branch @@ -61,10 +61,10 @@ instructions. Then make the changes needed for the pull request and push the local branch back to GitHub: ```bash -git push upstream LOCAL_BRANCH_NAME +git push LOCAL_BRANCH_NAME ``` -Where `LOCAL_BRANCH_NAME` is the name you gave to the PR branch when you +where `` is the remote (usually `origin`) and `LOCAL_BRANCH_NAME` is the name you gave to the PR branch when you fetched it from GitHub. Note that if the user who created the pull request selected the option diff --git a/docs/wiki/dev-guides/Release-Process.md b/docs/wiki/dev-guides/Release-Process.md index 8b8c05507..1c280fba9 100644 --- a/docs/wiki/dev-guides/Release-Process.md +++ b/docs/wiki/dev-guides/Release-Process.md @@ -76,16 +76,16 @@ this, you will need to ensure `bump2version` is installed into your development environment. > \[!NOTE\] -> The following steps assume you are pushing to the main `Point72/csp` -> repo. If you are working from a personal fork, use the corresponding -> remote (e.g. `upstream`) instead of `origin` in all git commands. +> If you are working on the main `Point72/csp` repository, set the +> remote as `origin` in all git commands. If you are working off a personal fork, +> use the corresponding remote of the main repository (e.g. `upstream`). > Ensure tags are still pushed to `Point72/csp` directly. 1. Ensure your local clone of `csp` is synced up with GitHub, including any tags that have been pushed since you last synced: ```bash - git pull upstream main --tags + git pull main --tags ``` 1. Make a branch and update version numbers in your local clone using @@ -137,7 +137,7 @@ development environment. 1. Push the tag to GitHub using the tag name created in the previous step. ```bash - git push origin tag v0.2.0 + git push tag v0.2.0 ``` You will need access in the repository settings to be able to push