Skip to content

Commit 6533579

Browse files
committed
first pass on updates to first-contribution script
1 parent af0fb9d commit 6533579

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

content/contributors/first-contribution.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,20 +44,20 @@ There are some links below the video to help you get these elements ready in cas
4444

4545
Now, we can get started.
4646

47-
### Step 1: Fork the projects repo
47+
### Step 1: Fork the project’s repo
4848

4949
Go to the project’s repository and click the “Fork” button at the top left of the page. This will create a copy of the repository in your own account.
5050

5151
### Step 2: Clone your fork
5252

5353
On your new fork, click the green “Code” button and copy the link that appears there to get the URL for cloning it.
5454

55-
Now, open your terminal (or Git Bash, if you’ve installed Git for Windows) and type the command git clone followed by pasting the URL you just copied. With this, you now have a local copy of your fork.
55+
Now, open your terminal (or Git Bash, if you’ve installed Git for Windows) and type the command `git clone` followed by pasting the URL you just copied. With this, you now have a local copy of your fork.
5656

5757
Finally, change to the directory of the repo you just cloned and add the the project’s repo as the “upstream” remote repository by typing the following:
5858

5959
```bash
60-
git remote add upstream https://github.com/.git
60+
git remote add upstream https://github.com/organization-name/project-name.git
6161
```
6262

6363
### Step 3: Set up your development environment
@@ -117,6 +117,18 @@ git push -u origin [BRANCH NAME]
117117

118118
Enter your GitHub username and password if requested.
119119

120+
{{< notice note >}}
121+
Entering your username and password every time you run `git push` can get tedious!
122+
Luckily GitHub lets you use an SSH key to authenticate automatically.
123+
Basically this involves creating two special files: one kept secret on your computer, and one uploaded to GitHub. If you want to set that up, see here:
124+
125+
- https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
126+
- https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account
127+
128+
You can also set up an SSH key using the `gh` command-line tool: https://cli.github.com/manual/ if you prefer.
129+
Mac and Windows users (but not Linux users!) who prefer to use `git` through a GUI can manage authentication using the [GitHub Desktop app](https://desktop.github.com/).
130+
{{< /notice >}}
131+
120132
### Step 9: Open PR
121133

122134
Now, you can submit your changes to the project’s repo.

0 commit comments

Comments
 (0)