Skip to content

Commit 71fccef

Browse files
lisli1smoralesd
authored andcommitted
docs: update readme to include fork instructions (#872)
* update readme and git-branch-setup * fix indents for readability * add list item under clone
1 parent c5aca49 commit 71fccef

File tree

2 files changed

+34
-32
lines changed

2 files changed

+34
-32
lines changed

README.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,9 @@ Please ensure that you have at least the **minimum** recommended versions
3232

3333
> In case you don't have yarn, please install from: [Yarn](https://yarnpkg.com/en/)
3434
35-
#### 1. Clone the repository
35+
#### 1. Fork and clone the repository
3636

37-
- Clone the repository using one of the following commands
38-
```bash
39-
git clone https://github.com/Microsoft/accessibility-insights-web.git
40-
```
41-
or
42-
```bash
43-
git clone git@github.com:Microsoft/accessibility-insights-web.git
44-
```
45-
- Select the created directory
46-
```bash
47-
cd accessibility-insights-web
48-
```
37+
- [Fork and clone the repository](docs/git-branch-setup.md)
4938

5039
#### 2. Install packages
5140

docs/git-branch-setup.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,24 @@ count. In your own fork, you can create as many branches as you like.
2020
- Navigate to the [accessibility-insights-web](https://github.com/Microsoft/accessibility-insights-web) repository in the same browser session.
2121
- Click on the **Fork** button at the top right corner of the page.
2222
- Create the fork under your account. Your GitHub profile should now show **accessibility-insights-web** as one of your repositories.
23-
- Create a folder on your device and clone your fork of the **accessibility-insights-web** repository. e.g. `https://github.com/ada-cat/accessibility-insights-web`. Notice how your GitHub username is in the repository location.
2423

25-
```
26-
> git clone https://github.com/ada-cat/accessibility-insights-web
27-
```
24+
## Cloning your fork
25+
26+
- Create a folder on your device and clone your fork of the **accessibility-insights-web** repository using one of the following commands. _Notice how your GitHub username is in the repository location._
27+
28+
- Using HTTPS
29+
```bash
30+
> git clone https://github.com/ada-cat/accessibility-insights-web.git
31+
```
32+
- or if you prefer SSH
33+
```bash
34+
> git clone git@github.com:ada-cat/accessibility-insights-web.git
35+
```
36+
37+
- Select the created directory
38+
```bash
39+
> cd accessibility-insights-web
40+
```
2841

2942
## Setting up the upstream repository
3043

@@ -33,27 +46,27 @@ primary **accessibility-insights-web** repository.
3346

3447
- When you run git remote -v, you should see only your fork in the output list
3548

36-
```
37-
> git remote -v
38-
origin https://github.com/ada-cat/accessibility-insights-web (fetch)
39-
origin https://github.com/ada-cat/accessibility-insights-web (push)
40-
```
49+
```bash
50+
> git remote -v
51+
origin https://github.com/ada-cat/accessibility-insights-web (fetch)
52+
origin https://github.com/ada-cat/accessibility-insights-web (push)
53+
```
4154

4255
- Map the primary **accessibility-insights-web** as the upstream remote
4356

44-
```
45-
> git remote add upstream https://github.com/Microsoft/accessibility-insights-web
46-
```
57+
```bash
58+
> git remote add upstream https://github.com/Microsoft/accessibility-insights-web
59+
```
4760

4861
- Now running `git remote -v` should show the upstream repository also
4962

50-
```
51-
> git remote -v
52-
origin https://github.com/ada-cat/accessibility-insights-web (fetch)
53-
origin https://github.com/ada-cat/accessibility-insights-web (push)
54-
upstream https://github.com/Microsoft/accessibility-insights-web (fetch)
55-
upstream https://github.com/Microsoft/accessibility-insights-web (push)
56-
```
63+
```bash
64+
> git remote -v
65+
origin https://github.com/ada-cat/accessibility-insights-web (fetch)
66+
origin https://github.com/ada-cat/accessibility-insights-web (push)
67+
upstream https://github.com/Microsoft/accessibility-insights-web (fetch)
68+
upstream https://github.com/Microsoft/accessibility-insights-web (push)
69+
```
5770

5871
- At this point you are ready to start branching and contributing back changes.
5972

0 commit comments

Comments
 (0)