Skip to content

Commit 0b26384

Browse files
committed
docs: update dev environment instructions
Updates the dev environment instructions to mention how to run tests properly. Also removes global Gulp as a required step for setting up the environment and changes the Gulp commands to go through yarn.
1 parent 12edc0b commit 0b26384

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

DEV_ENVIRONMENT.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,21 @@
66
- On Windows: Follow the [instructions](https://docs.bazel.build/versions/master/install-windows.html#5-optional-install-compilers-and-language-runtimes)
77
to install [`MSYS2`](https://www.msys2.org/) and the listed "Common MSYS2 packages".
88
Afterwards add `C:\msys64\usr\bin` to the `PATH` environment variable.
9-
3. Run `yarn global add gulp` to install gulp.
10-
4. Fork the `angular/components` repo on GitHub.
11-
5. Clone your fork to your machine with `git clone`.
9+
3. Fork the `angular/components` repo on GitHub.
10+
4. Clone your fork to your machine with `git clone`.
1211
Recommendation: name your git remotes `upstream` for `angular/components`
1312
and `<your-username>` for your fork. Also see the [team git shortcuts](https://github.com/angular/components/wiki/Team-git----bash-shortcuts).
14-
6. From the root of the project, run `yarn`.
13+
5. From the root of the project, run `yarn dev-app`.
1514

1615

17-
To build angular/components in dev mode, run `gulp material:build`.
18-
To build angular/components in release mode, run `gulp material:build-release`
16+
To build angular/components in dev mode, run `yarn gulp material:build`.
17+
To build angular/components in release mode, run `yarn gulp material:build-release`
1918

2019
To bring up a local server, run `yarn dev-app`. This will automatically watch for changes
2120
and rebuild. The browser should refresh automatically when changes are made.
2221

2322
### Running tests
2423

25-
To run unit tests, run `yarn test`.
24+
To run unit tests, run `yarn test <target>`. E.g. `yarn test button`.
2625
To run the e2e tests, run `yarn e2e`.
2726
To run lint, run `yarn lint`.

0 commit comments

Comments
 (0)