From cf787c7e005acb1cfae655cf7d34963fe64efa89 Mon Sep 17 00:00:00 2001 From: hacker65536 Date: Thu, 28 Nov 2019 03:45:28 +0900 Subject: [PATCH] chore(docs): update CONTRIBUTING (#4754) --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 86f9c0ccb0a8d..b350ae3fc676c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -367,7 +367,7 @@ $ docker run -v $(pwd):/app -w /app aws-cdk In many cases, you don't really need to build the entire project. Say you want to work on the `@aws-cdk/aws-ec2` module: ```console -$ ./install.sh +$ yarn install $ cd packages/@aws-cdk/aws-ec2 $ ../../../scripts/buildup ``` @@ -448,7 +448,7 @@ Guidelines: * Make sure dependencies are defined using [caret ranges](https://docs.npmjs.com/misc/semver#caret-ranges-123-025-004) (e.g. `^1.2.3`). This enables non-breaking updates to automatically be picked up. - * Make sure `package-lock.json` files are included in your commit. + * Make sure `yarn.lock` is included in your commit. ### Finding dependency cycles between packages @@ -471,7 +471,7 @@ Cycle: @aws-cdk/aws-sns => @aws-cdk/aws-lambda => @aws-cdk/aws-codecommit => @aw To update all dependencies (without bumping major versions): 1. Obtain a fresh clone from "master". -2. Run `./install.sh` +2. Run `yarn install` 3. Run `./scripts/update-dependencies.sh --mode full` (use `--mode semver` to avoid bumping major versions) 4. Submit a Pull Request.