Skip to content

Commit a5565c4

Browse files
author
Crystal Tenn
committed
Add notes to contributing doc
1 parent 3f2fb77 commit a5565c4

1 file changed

Lines changed: 15 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ These are one time installations required to be able to test your changes locall
3434
1. Install [Node.js](https://nodejs.org/en/download/) for your platform
3535
1. Install [VS Code](https://code.visualstudio.com/download) for your platform
3636
1. Install the dependencies. From the repository root run:
37+
3738
```bash
38-
$ npm i
39+
npm i
3940
```
4041

4142
## Making & testing changes
@@ -47,13 +48,13 @@ The extension is written in TypeScript and built using [webpack](https://webpack
4748
Build changes (one time):
4849

4950
```bash
50-
$ npm run build
51+
npm run build
5152
```
5253

5354
Or to watch for changes and automatically rebuild every time on save:
5455

5556
```bash
56-
$ npm run watch
57+
npm run watch
5758
```
5859

5960
### Testing changes
@@ -65,53 +66,55 @@ $ npm run watch
6566
* "Run Web Extension in VS Code" - run the [web version](https://code.visualstudio.com/api/extension-guides/web-extensions) of the extension
6667

6768
### 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).
7071
1. Make change
7172
1. Hit the refresh button in the debugger window to reload the extension in the development host
7273

7374
### Running tests
7475

76+
_Note: We added `cross-env` to our package.json so that this works on both Mac and Windows._
77+
7578
```bash
76-
$ npm test
79+
npm test
7780
```
7881

7982
Or to watch for changes and run tests:
8083

8184
```bash
82-
$ npm run test-watch
85+
npm run test-watch
8386
```
8487

8588
### Lint
8689

8790
```bash
88-
$ npm run lint
91+
npm run lint
8992
```
9093

9194
Run linter and fix errors as possible:
9295

9396
```bash
94-
$ npm run lint-fix
97+
npm run lint-fix
9598
```
9699

97100
### Format
98101

99102
Check formatting with [prettier](https://prettier.io/):
100103

101104
```bash
102-
$ npm run format-check
105+
npm run format-check
103106
```
104107

105108
Run prettier and automatically format:
106109

107110
```bash
108-
$ npm run format
111+
npm run format
109112
```
110113

111114
### Package the extension
112115

113116
```bash
114-
$ npm run package
117+
npm run package
115118
```
116119

117120
## Submitting a pull request
@@ -135,7 +138,6 @@ Here are a few things you can do that will increase the likelihood of your pull
135138
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
136139
- [GitHub Help](https://help.github.com)
137140

138-
139141
[bug issues]: https://github.com/github/vscode-github-actions/labels/bug
140142
[feature request issues]: https://github.com/github/vscode-github-actions/labels/enhancement
141143
[hw]: https://github.com/github/vscode-github-actions/labels/help%20wanted

0 commit comments

Comments
 (0)