From 437df67fef31dbb9caccca3014fed1458d9d3bd3 Mon Sep 17 00:00:00 2001 From: Hin Yan Liew Date: Tue, 4 Feb 2025 10:52:45 -0500 Subject: [PATCH 1/2] Added warning to set credentials before working with forks --- _docs/developer/getting_started/commit_to_PR_from_fork.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/_docs/developer/getting_started/commit_to_PR_from_fork.md b/_docs/developer/getting_started/commit_to_PR_from_fork.md index af95ff3a..b47a96f8 100644 --- a/_docs/developer/getting_started/commit_to_PR_from_fork.md +++ b/_docs/developer/getting_started/commit_to_PR_from_fork.md @@ -65,6 +65,13 @@ The instructions below are for command line use of git. and review the PR and make code edits and new commits to your local branch as needed. + Note: make sure your git credentials are set before pulling or pushing to a forked + branch. You can do this with the following commands. Use the --global flag if you + want to set this outside of just Submitty. + ''' + git config user.name "Your Name" + git config user.email "Your Email" + ''' 5. In order to push the changes to the contributor's fork (and the PR From dab1cd817641dad9b2a1b938535d7304e4560394 Mon Sep 17 00:00:00 2001 From: Hin Yan Liew Date: Tue, 4 Feb 2025 11:03:54 -0500 Subject: [PATCH 2/2] Changed order and minor fixes --- .../getting_started/commit_to_PR_from_fork.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/_docs/developer/getting_started/commit_to_PR_from_fork.md b/_docs/developer/getting_started/commit_to_PR_from_fork.md index b47a96f8..30ec50a2 100644 --- a/_docs/developer/getting_started/commit_to_PR_from_fork.md +++ b/_docs/developer/getting_started/commit_to_PR_from_fork.md @@ -40,7 +40,15 @@ The instructions below are for command line use of git. ``` Additionally, find the name of the fork on the fork's page on Github. - The `fork_name` may simply be `Submitty`, or the author may have chosen to another name. + The `fork_name` may simply be `Submitty`, or the author may have chosen another name. + + Note: make sure your git credentials are set before pulling or pushing to a forked + repo. You can do this with the following commands. Use the `--global` flag if you + want to set this outside of just Submitty. + ``` + git config user.name "Your Name" + git config user.email "Your Email" + ``` 3. Next, make a local branch on your computer in your working repository @@ -65,13 +73,6 @@ The instructions below are for command line use of git. and review the PR and make code edits and new commits to your local branch as needed. - Note: make sure your git credentials are set before pulling or pushing to a forked - branch. You can do this with the following commands. Use the --global flag if you - want to set this outside of just Submitty. - ''' - git config user.name "Your Name" - git config user.email "Your Email" - ''' 5. In order to push the changes to the contributor's fork (and the PR