You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,8 +34,9 @@ These are one time installations required to be able to test your changes locall
34
34
1. Install [Node.js](https://nodejs.org/en/download/) for your platform
35
35
1. Install [VS Code](https://code.visualstudio.com/download) for your platform
36
36
1. Install the dependencies. From the repository root run:
37
+
37
38
```bash
38
-
$ npm i
39
+
npm i
39
40
```
40
41
41
42
## Making & testing changes
@@ -47,13 +48,13 @@ The extension is written in TypeScript and built using [webpack](https://webpack
47
48
Build changes (one time):
48
49
49
50
```bash
50
-
$ npm run build
51
+
npm run build
51
52
```
52
53
53
54
Or to watch for changes and automatically rebuild every time on save:
54
55
55
56
```bash
56
-
$ npm run watch
57
+
npm run watch
57
58
```
58
59
59
60
### Testing changes
@@ -65,53 +66,55 @@ $ npm run watch
65
66
* "Run Web Extension in VS Code" - run the [web version](https://code.visualstudio.com/api/extension-guides/web-extensions) of the extension
66
67
67
68
### Dev loop
68
-
1. Setup `Watch all & Launch Extension` under Debug and hit the green button
69
-
1.`npm run watch`
69
+
70
+
1.Setup `Watch all & Launch Extension (workspace)` under Debug and hit the green button (this will automatically run `npm watch` for you and monitor for changes).
70
71
1. Make change
71
72
1. Hit the refresh button in the debugger window to reload the extension in the development host
72
73
73
74
### Running tests
74
75
76
+
_Note: We added `cross-env` to our package.json so that this works on both Mac and Windows._
77
+
75
78
```bash
76
-
$ npm test
79
+
npm test
77
80
```
78
81
79
82
Or to watch for changes and run tests:
80
83
81
84
```bash
82
-
$ npm run test-watch
85
+
npm run test-watch
83
86
```
84
87
85
88
### Lint
86
89
87
90
```bash
88
-
$ npm run lint
91
+
npm run lint
89
92
```
90
93
91
94
Run linter and fix errors as possible:
92
95
93
96
```bash
94
-
$ npm run lint-fix
97
+
npm run lint-fix
95
98
```
96
99
97
100
### Format
98
101
99
102
Check formatting with [prettier](https://prettier.io/):
100
103
101
104
```bash
102
-
$ npm run format-check
105
+
npm run format-check
103
106
```
104
107
105
108
Run prettier and automatically format:
106
109
107
110
```bash
108
-
$ npm run format
111
+
npm run format
109
112
```
110
113
111
114
### Package the extension
112
115
113
116
```bash
114
-
$ npm run package
117
+
npm run package
115
118
```
116
119
117
120
## Submitting a pull request
@@ -135,7 +138,6 @@ Here are a few things you can do that will increase the likelihood of your pull
0 commit comments