Skip to content

Commit

Permalink
[core] Set required yarn version (#12864)
Browse files Browse the repository at this point in the history
* [core] Set required yarn version

Before 1.4.0 bin commands could not be found when executed from
a workspace. See yarnpkg/yarn#4848

* Revert "[core] Set required yarn version"

This reverts commit e6260e3.

Netlify uses 1.3.2 which has the same issue. This also limits
users not just contributors.

* [core] Add note about build prerequisites

* Update CONTRIBUTING.md
  • Loading branch information
eps1lon authored and oliviertassinari committed Sep 13, 2018
1 parent c683d68 commit 3d828ec
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ To update the component API documentation (auto generated from component PropTyp
yarn docs:api
```

### Building locally

To use the provided build scripts with yarn you have to install `yarn@^1.4.0`.
Depending on the package you want to build just run `yarn workspace @material-ui/PACKAGE build`.

### Coding style

Please follow the coding style of the current code base. Material-UI uses eslint, so if possible, enable linting in your editor to get real-time feedback. The linting rules are also run when Webpack recompiles your changes, and can be run manually with `yarn lint`.
Expand Down

0 comments on commit 3d828ec

Please sign in to comment.