Skip to content

Commit

Permalink
Fix maintainer instructions for checking out PRs (#344)
Browse files Browse the repository at this point in the history
Signed-off-by: Adam Glustein <Adam.Glustein@Point72.com>
  • Loading branch information
AdamGlustein authored Jul 18, 2024
1 parent 4b7c37a commit 29749f3
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/wiki/dev-guides/GitHub-Conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/<ID>/HEAD/:LOCAL_BRANCH_NAME
git fetch <remote> pull/<ID>/head:LOCAL_BRANCH_NAME
```

where `<ID>` is the PR ID number and `LOCAL_BRANCH_NAME` is a name
where `<remote>` is the remote (usually `origin`), `<ID>` 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
Expand All @@ -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 <remote> LOCAL_BRANCH_NAME
```
Where `LOCAL_BRANCH_NAME` is the name you gave to the PR branch when you
where `<remote>` 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
Expand Down
10 changes: 5 additions & 5 deletions docs/wiki/dev-guides/Release-Process.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <remote> main --tags
```

1. Make a branch and update version numbers in your local clone using
Expand Down Expand Up @@ -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 <remote> tag v0.2.0
```

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

0 comments on commit 29749f3

Please sign in to comment.