Skip to content

Commit 762edd1

Browse files
committed
Fix CONTRIBUTING.md to reflect changes to build process.
1 parent b3dc7d7 commit 762edd1

File tree

1 file changed

+7
-63
lines changed

1 file changed

+7
-63
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -32,85 +32,29 @@ Here are a few things you can do that will increase the likelihood of your pull
3232
Make sure you have a fairly recent version of vscode (>1.32) and are using nodejs
3333
version >=v10.13.0. (Tested on v10.15.1 and v10.16.0).
3434

35-
This repo uses [Rush](https://rushjs.io) to handle package management, building, and other
36-
operations across multiple projects. See the Rush "[Getting started as a developer](https://rushjs.io/pages/developer/new_developer/)" docs
37-
for more details.
38-
39-
If you plan on building from the command line, it's easiest if Rush is installed globally:
40-
41-
```shell
42-
npm install -g @microsoft/rush
43-
```
44-
45-
To get started, run:
46-
47-
```shell
48-
rush update && rush build
49-
```
50-
51-
Note that when you run the `rush` command from the globally installed version, it will examine the
52-
`rushVersion` property in the repo's `rush.json`, and if it differs from the globally installed
53-
version, it will download, cache, and run the version of Rush specified in the `rushVersion`
54-
property.
55-
56-
A few more things to know about using rush:
57-
58-
* Avoid running `npm` for any commands that install/link dependencies
59-
* Instead use the *rush* equivalent: `rush add <package>`, `rush update`, etc.
60-
* If you plan on only building via VS Code tasks, you don't need Rush installed at all, since those
61-
tasks run `common/scripts/install-run-rush.js` to bootstrap a locally installed and cached copy of
62-
Rush.
63-
6435
### Building
6536

66-
#### Installing all packages (instead of `npm install`)
67-
68-
After updating any `package.json` file, or after checking or pulling a new branch, you need to
69-
make sure all the right npm packages are installed, which you would normally do via `npm install` in
70-
a single-project repo. With Rush, you need to do an "update" instead:
71-
72-
##### From VS Code
37+
#### Installing all packages
7338

74-
`Terminal > Run Task... > Update`
39+
Run
7540

7641
##### From the command line
7742

7843
```shell
79-
rush update
44+
npm install
8045
```
8146

82-
#### Building all projects (instead of `gulp`)
47+
from the directory `extensions/ql-vscode`.
8348

84-
Rush builds all projects in the repo, in dependency order, building multiple projects in parallel
85-
where possible. By default, the build also packages the extension itself into a .vsix file in the
86-
`dist` directory. To build:
87-
88-
##### From VS Code
89-
90-
`Terminal > Run Build Task...` (or just `Ctrl+Shift+B` with the default key bindings)
91-
92-
##### From the command line
49+
#### Building
9350

9451
```shell
95-
rush build --verbose
52+
gulp
9653
```
9754

98-
#### Forcing a clean build
99-
100-
Rush does a reasonable job of detecting on its own which projects need to be rebuilt, but if you need to
101-
force a full rebuild of all projects:
102-
10355
##### From VS Code
10456

105-
`Terminal > Run Task... > Rebuild`
106-
107-
##### From the command line
108-
109-
```shell
110-
rush rebuild --verbose
111-
```
112-
113-
Note that `rush rebuild` performs a complete rebuild, whereas `rush build` performs an incremental build and in many cases will not need to do anything at all.
57+
`Terminal > Run Build Task...` (or just `Ctrl+Shift+B` with the default key bindings)
11458

11559
### Installing
11660

0 commit comments

Comments
 (0)