Skip to content

Commit 09a5b16

Browse files
committed
Preliminary updating steps for pushing to a fork
1 parent d96d8c4 commit 09a5b16

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

_docs/developer/getting_started/commit_to_PR_from_fork.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,14 @@ merging to the main branch.
2020

2121
The instructions below are for command line use of git.
2222

23+
1. **Before** you begin, confirm that your lcoal main branch of Submitty is
24+
up-to-date. Additionally, if the PR's branch is not up-to-date with Submitty's main,
25+
there will be a button on its Github webpage that you can press to update it.
26+
You may need to resolve some merge conflicts in the process of updating it.
27+
28+
![alt text](/images/update-branch.png)
2329

24-
1. First, from the PR on the Github website, find the name of the
30+
2. From the PR on the Github website, find the name of the
2531
user + branch name. It should be formatted something like this:
2632
```
2733
contributorusername:contributor_branch_name
@@ -31,7 +37,7 @@ The instructions below are for command line use of git.
3137
The `fork_name` may simply be `Submitty`, or the author may have chosen to another name.
3238
3339
34-
2. Next, make a local branch on your computer in your working repository
40+
3. Next, make a local branch on your computer in your working repository
3541
with the proposed code changes. Here are the command lines
3642
(substitute the user, branch, and fork names we found above):
3743
@@ -48,14 +54,14 @@ The instructions below are for command line use of git.
4854
```
4955
5056
51-
3. This has made a local branch named
57+
4. This has made a local branch named
5258
`contributorusername-contributor_branch_name`. Go ahead and test
5359
and review the PR and make code edits and new commits to your
5460
local branch as needed.
5561
5662
5763
58-
4. In order to push the changes to the contributor's fork (and the PR
64+
5. In order to push the changes to the contributor's fork (and the PR
5965
on Github from the fork), you will specify the upstream to be the
6066
contributor's fork:
6167
@@ -93,7 +99,7 @@ The instructions below are for command line use of git.
9399
```
94100
95101
96-
5. Now once you are finished with your code changes, first commit them to
102+
6. Now once you are finished with your code changes, first commit them to
97103
the local branch (named
98104
`contributorusername-contributor_branch_name`).
99105
@@ -106,7 +112,7 @@ The instructions below are for command line use of git.
106112
*NOTE: If you encounter a permissions error, it is possible that the external
107113
contributor didn't grant access for collaboration on the branch.*
108114
109-
6. Confirm that you can see the changes on the Github website for the PR.
115+
7. Confirm that you can see the changes on the Github website for the PR.
110116
111117
112118
---

images/update-branch.png

17.3 KB
Loading

0 commit comments

Comments
 (0)