Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Recommend yarn link to test local distribution #13348

Merged
merged 3 commits into from
Oct 23, 2018
Merged

[docs] Recommend yarn link to test local distribution #13348

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f403d20
Recommend yarn link to test local distribution
nicolasiensen Oct 22, 2018
9cf157e
Merge branch 'master' into recommend-yarn-link
nicolasiensen Oct 22, 2018
7b0353b
Empty commit to force codecov to work
eps1lon Oct 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,18 @@ cd packages/material-ui
yarn build
```

Then, you can add Material-UI to any project you want to try your changes:
Then, you create a link to your local distribution:

```shell
cd build
yarn link
```

Next, you link your local distribution of Material-UI to any project you want to try your changes:

```shell
# From the root folder of any project
yarn add file:<path-to-material-ui-project>/packages/material-ui/build
yarn link "@material-ui/core"
```

Now, every time you import `material-ui` in your project, it is going to use your local distribution.
Expand Down