Skip to content

Commit 728470a

Browse files
authored
[Documentation:Developer] set git credentials working with forks (#655)
**Summary:** Added a small warning in the "Commit to PR from fork" page that tells developers to ensure that their git credentials are set before pulling and pushing from forks. If credentials are not set, then some commands will fail. This change would help newer developers who might not be proficient with git. **Testing** - Verified that changes appeared on the page - Format looks good
1 parent 168191c commit 728470a

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

_docs/developer/getting_started/commit_to_PR_from_fork.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,15 @@ The instructions below are for command line use of git.
4040
```
4141
4242
Additionally, find the name of the fork on the fork's page on Github.
43-
The `fork_name` may simply be `Submitty`, or the author may have chosen to another name.
43+
The `fork_name` may simply be `Submitty`, or the author may have chosen another name.
44+
45+
Note: make sure your git credentials are set before pulling or pushing to a forked
46+
repo. You can do this with the following commands. Use the `--global` flag if you
47+
want to set this outside of just Submitty.
48+
```
49+
git config user.name "Your Name"
50+
git config user.email "Your Email"
51+
```
4452
4553
4654
3. Next, make a local branch on your computer in your working repository

0 commit comments

Comments
 (0)