Skip to content

Commit cd8c282

Browse files
Merge pull request #86 from github/ketchup/modifyContribuitingSteps
Update CONTRIBUTING.md
2 parents 6a739fb + 20254a5 commit cd8c282

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ The extension is written in TypeScript and built using [webpack](https://webpack
4242

4343
### Build
4444

45-
Build changes:
45+
Build changes (one time):
4646

4747
```bash
4848
$ npm run build
4949
```
5050

51-
or to watch for changes
51+
Or to watch for changes and automatically rebuild every time on save:
5252

5353
```bash
5454
$ npm run watch
@@ -62,13 +62,19 @@ $ npm run watch
6262
* "Attach to Language-Server" - attach to an instance of the language server running on port `6010`
6363
* "Run Web Extension in VS Code" - run the [web version](https://code.visualstudio.com/api/extension-guides/web-extensions) of the extension
6464

65+
### Dev loop
66+
1. Setup `Watch all & Launch Extension` under Debug and hit the green button
67+
1. `npm run watch`
68+
1. Make change
69+
1. Hit the refresh button in the debugger window to reload the extension in the development host
70+
6571
### Running tests
6672

6773
```bash
6874
$ npm test
6975
```
7076

71-
or to watch for changes and run tests:
77+
Or to watch for changes and run tests:
7278

7379
```bash
7480
$ npm run test-watch
@@ -91,13 +97,13 @@ $ npm run lint-fix
9197
Check formatting with [prettier](https://prettier.io/):
9298

9399
```bash
94-
$ npm run prettier
100+
$ npm run format-check
95101
```
96102

97103
Run prettier and automatically format:
98104

99105
```bash
100-
$ npm run prettier-fix
106+
$ npm run format
101107
```
102108

103109
### Package the extension
@@ -125,4 +131,4 @@ Here are a few things you can do that will increase the likelihood of your pull
125131

126132
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
127133
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
128-
- [GitHub Help](https://help.github.com)
134+
- [GitHub Help](https://help.github.com)

0 commit comments

Comments
 (0)