Skip to content

Commit

Permalink
[docs] Add yarn install instructions in CONTRIBUTING.md (#18970)
Browse files Browse the repository at this point in the history
  • Loading branch information
hiteshkundal authored and oliviertassinari committed Dec 24, 2019
1 parent c6f734f commit 862f224
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ When in doubt, keep your Pull Requests small. To give a Pull Request the best ch

1. Fork the repository.

2. Clone the fork to your local machine and add upstream remote
2. Clone the fork to your local machine and add upstream remote:

```sh
git clone git@github.com:<yourname>/material-ui.git
Expand All @@ -46,19 +46,25 @@ git checkout master
git pull upstream master
```

4. Create a new topic branch:
4. Install the dependencies:

```sh
git checkout -b my-topic-branch
yarn install
```

5. Make changes, commit and push to your fork:
5. Create a new topic branch:

```sh
git checkout -b my-topic-branch
````

6. Make changes, commit and push to your fork:

```sh
git push -u
```

6. Go to [the repository](https://github.com/mui-org/material-ui) and make a Pull Request.
7. Go to [the repository](https://github.com/mui-org/material-ui) and make a Pull Request.

The core team is monitoring for Pull Requests. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.

Expand Down

0 comments on commit 862f224

Please sign in to comment.