@@ -20,8 +20,14 @@ merging to the main branch.
20
20
21
21
The instructions below are for command line use of git.
22
22
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 )
23
29
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
25
31
user + branch name. It should be formatted something like this:
26
32
```
27
33
contributorusername:contributor_branch_name
@@ -31,7 +37,7 @@ The instructions below are for command line use of git.
31
37
The `fork_name` may simply be `Submitty`, or the author may have chosen to another name.
32
38
33
39
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
35
41
with the proposed code changes. Here are the command lines
36
42
(substitute the user, branch, and fork names we found above):
37
43
@@ -48,14 +54,14 @@ The instructions below are for command line use of git.
48
54
```
49
55
50
56
51
- 3 . This has made a local branch named
57
+ 4 . This has made a local branch named
52
58
`contributorusername-contributor_branch_name`. Go ahead and test
53
59
and review the PR and make code edits and new commits to your
54
60
local branch as needed.
55
61
56
62
57
63
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
59
65
on Github from the fork), you will specify the upstream to be the
60
66
contributor's fork:
61
67
@@ -93,7 +99,7 @@ The instructions below are for command line use of git.
93
99
```
94
100
95
101
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
97
103
the local branch (named
98
104
`contributorusername-contributor_branch_name`).
99
105
@@ -106,7 +112,7 @@ The instructions below are for command line use of git.
106
112
*NOTE: If you encounter a permissions error, it is possible that the external
107
113
contributor didn't grant access for collaboration on the branch.*
108
114
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.
110
116
111
117
112
118
---
0 commit comments