Skip to content

Commit 29749f3

Browse files
authored
Fix maintainer instructions for checking out PRs (#344)
Signed-off-by: Adam Glustein <[email protected]>
1 parent 4b7c37a commit 29749f3

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/wiki/dev-guides/GitHub-Conventions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/
3434
1. Fetch the pull request ref and assign it to a local branch name.
3535

3636
```bash
37-
git fetch upstream pull/<ID>/HEAD/:LOCAL_BRANCH_NAME
37+
git fetch <remote> pull/<ID>/head:LOCAL_BRANCH_NAME
3838
```
3939

40-
where `<ID>` is the PR ID number and `LOCAL_BRANCH_NAME` is a name
40+
where `<remote>` is the remote (usually `origin`), `<ID>` is the PR ID number and `LOCAL_BRANCH_NAME` is a name
4141
chosen for the PR branch in your local checkout of CSP.
4242

4343
1. Switch to the PR branch
@@ -61,10 +61,10 @@ instructions. Then make the changes needed for the pull request and push
6161
the local branch back to GitHub:
6262

6363
```bash
64-
git push upstream LOCAL_BRANCH_NAME
64+
git push <remote> LOCAL_BRANCH_NAME
6565
```
6666

67-
Where `LOCAL_BRANCH_NAME` is the name you gave to the PR branch when you
67+
where `<remote>` is the remote (usually `origin`) and `LOCAL_BRANCH_NAME` is the name you gave to the PR branch when you
6868
fetched it from GitHub.
6969

7070
Note that if the user who created the pull request selected the option

docs/wiki/dev-guides/Release-Process.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,16 @@ this, you will need to ensure `bump2version` is installed into your
7676
development environment.
7777

7878
> \[!NOTE\]
79-
> The following steps assume you are pushing to the main `Point72/csp`
80-
> repo. If you are working from a personal fork, use the corresponding
81-
> remote (e.g. `upstream`) instead of `origin` in all git commands.
79+
> If you are working on the main `Point72/csp` repository, set the
80+
> remote as `origin` in all git commands. If you are working off a personal fork,
81+
> use the corresponding remote of the main repository (e.g. `upstream`).
8282
> Ensure tags are still pushed to `Point72/csp` directly.
8383
8484
1. Ensure your local clone of `csp` is synced up with GitHub, including
8585
any tags that have been pushed since you last synced:
8686

8787
```bash
88-
git pull upstream main --tags
88+
git pull <remote> main --tags
8989
```
9090

9191
1. Make a branch and update version numbers in your local clone using
@@ -137,7 +137,7 @@ development environment.
137137
1. Push the tag to GitHub using the tag name created in the previous step.
138138

139139
```bash
140-
git push origin tag v0.2.0
140+
git push <remote> tag v0.2.0
141141
```
142142

143143
You will need access in the repository settings to be able to push

0 commit comments

Comments
 (0)