Skip to content

Commit

Permalink
Add NodeJS and Yarn version recommendations in CONTRIBUTING.md (#10837)
Browse files Browse the repository at this point in the history
Co-authored-by: Aaron S <[email protected]>
  • Loading branch information
MixMasterT and stocaaro authored Mar 2, 2023
1 parent 4d4712c commit aa379c5
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 @@ -48,6 +48,11 @@ Our work is done directly on Github and PR's are sent to the GitHub repo by core

## Setting up for local development

The recommended version of Node JS to work with this project is [`16.19.0`](https://nodejs.org/en/blog/release/v16.19.0/) with Yarn version [`1.22.x`](https://github.com/yarnpkg/yarn/blob/master/CHANGELOG.md).

> Note: newer versions of Yarn (2+) remove support for lerna's `--mutex` flag
> so be sure to use Yarn v1.22.x
This section should get you running with **Amplify JS** and get you familiar with the basics of the codebase. You will need the latest version of [Node.js](https://nodejs.org/en/) on your system and developing locally also requires `yarn` workspaces. You can install it [here](https://classic.yarnpkg.com/en/docs/install#mac-stable).

Start by [forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the main branch of [amplify-js](https://github.com/aws-amplify/amplify-js).
Expand Down

0 comments on commit aa379c5

Please sign in to comment.