Skip to content

Commit d96d8c4

Browse files
micpap25bmcutler
andauthored
[Documentation:Developer] Account for changed name of fork (#604)
This commit acknowledges external users may have changed the name of their fork from "Submitty" and guides developers on finding and using the fork name correctly --------- Co-authored-by: Barb Cutler <[email protected]>
1 parent 8bfe0e0 commit d96d8c4

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

_docs/developer/getting_started/commit_to_PR_from_fork.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,29 @@ The instructions below are for command line use of git.
2222

2323

2424
1. First, from the PR on the Github website, find the name of the
25-
fork + branch name. It should be formatted something like this:
25+
user + branch name. It should be formatted something like this:
2626
```
2727
contributorusername:contributor_branch_name
2828
```
2929
30+
Additionally, find the name of the fork on the fork's page on Github.
31+
The `fork_name` may simply be `Submitty`, or the author may have chosen to another name.
32+
3033
3134
2. Next, make a local branch on your computer in your working repository
32-
with the proposed code changes. Here are the command lines
33-
(substitute the fork & branch name we found above):
35+
with the proposed code changes. Here are the command lines
36+
(substitute the user, branch, and fork names we found above):
3437
3538
If you **are not** using ssh keys on git:
3639
```
3740
git checkout -b contributorusername-contributor_branch_name main
38-
git pull https://github.com/contributorusername/Submitty.git contributor_branch_name
41+
git pull https://github.com/contributorusername/fork_name.git contributor_branch_name
3942
```
4043
4144
If you **are** using ssh keys on git:
4245
```
4346
git checkout -b contributorusername-contributor_branch_name main
44-
git pull [email protected]:contributorusername/Submitty.git contributor_branch_name
47+
git pull [email protected]:contributorusername/fork_name.git contributor_branch_name
4548
```
4649
4750
@@ -58,13 +61,13 @@ The instructions below are for command line use of git.
5861
5962
If you **are not** using ssh keys on git:
6063
```
61-
git remote add upstream https://github.com/contributorusername/Submitty.git
64+
git remote add upstream https://github.com/contributorusername/fork_name.git
6265
```
6366
6467
6568
If you **are** using ssh keys on git:
6669
```
67-
git remote add upstream [email protected]:contributorusername/Submitty.git
70+
git remote add upstream [email protected]:contributorusername/fork_name.git
6871
```
6972
7073
@@ -77,16 +80,16 @@ The instructions below are for command line use of git.
7780
```
7881
origin https://github.com/Submitty/Submitty.git (fetch)
7982
origin https://github.com/Submitty/Submitty.git (push)
80-
upstream https://github.com/contributorusername/Submitty.git (fetch)
81-
upstream https://github.com/contributorusername/Submitty.git (push)
83+
upstream https://github.com/contributorusername/fork_name.git (fetch)
84+
upstream https://github.com/contributorusername/fork_name.git (push)
8285
```
8386
8487
Or this if you **are** using ssh keys on git:
8588
```
8689
origin [email protected]:Submitty/Submitty.git (fetch)
8790
origin [email protected]:Submitty/Submitty.git (push)
88-
upstream [email protected]:contributorusername/Submitty.git (fetch)
89-
upstream [email protected]:contributorusername/Submitty.git (push)
91+
upstream [email protected]:contributorusername/fork_name.git (fetch)
92+
upstream [email protected]:contributorusername/fork_name.git (push)
9093
```
9194
9295

0 commit comments

Comments
 (0)