Skip to content

Commit 73b2155

Browse files
author
Crystal Tenn
committed
Fix Dev loop & Testing changes section and rearrange / make more concise the instructions
1 parent 0bf3661 commit 73b2155

1 file changed

Lines changed: 21 additions & 23 deletions

File tree

CONTRIBUTING.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,26 @@ These are one time installations required to be able to test your changes locall
3939
npm i
4040
```
4141

42-
## Making & testing changes
42+
### Dev loop & Testing changes
4343

4444
The extension is written in TypeScript and built using [webpack](https://webpack.js.org/).
4545

46+
1. Go to the Debug tab.
47+
1. Hit `Watch all & Launch Extension (workspace)` if you want to work on the main VS Code extension like the left sidebar and the UI for the extension.
48+
1. Hit `Watch & Launch Extension + language-server (workspace)` If you want to work on the language services code and want to debug and work on the hover, syntax highlighting, and other functionality within the Workflow files.
49+
* This will attach to an instance of the language server running on port `6010`
50+
1. Hit the green button (this will automatically run `npm watch` for you and monitor for changes) which will open a local version of the extension using the _extension development host_.
51+
1. Make changes
52+
1. Hit the refresh button in the debugger window to reload the extension in the development host
53+
54+
## npm commands
55+
56+
For the below make sure that you are in the `vscode-github-actions` directory of your local repo first.
57+
58+
```bash
59+
cd vscode-github-actions
60+
```
61+
4662
### Build
4763

4864
Build changes (one time):
@@ -57,28 +73,6 @@ Or to watch for changes and automatically rebuild every time on save:
5773
npm run watch
5874
```
5975

60-
### Testing changes
61-
62-
1. Open the repository in VS Code
63-
1. Run one of the debug targets:
64-
* "Watch & Launch extension" - watch extension files, compile as necessary, and run the extension using the _extension development host_
65-
* "Attach to Language-Server" - attach to an instance of the language server running on port `6010`
66-
* "Run Web Extension in VS Code" - run the [web version](https://code.visualstudio.com/api/extension-guides/web-extensions) of the extension
67-
68-
### Dev loop
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).
71-
1. Make change
72-
1. Hit the refresh button in the debugger window to reload the extension in the development host
73-
74-
## npm commands
75-
76-
For the below make sure that you are in the `vscode-github-actions` directory of your local repo first.
77-
78-
```bash
79-
cd vscode-github-actions
80-
```
81-
8276
### Running tests
8377

8478
_Note: We added `cross-env` to our package.json so that this works on both Mac and Windows._
@@ -125,6 +119,10 @@ npm run format
125119
npm run package
126120
```
127121

122+
### Run Web Extension
123+
124+
"Run Web Extension in VS Code" - run the [web version](https://code.visualstudio.com/api/extension-guides/web-extensions) of the extension
125+
128126
## VS Code Source Control Repositories
129127

130128
If you don't see `vscode-github-actions` and `languageservices`, please go to `Preferences: Open User Settings` and then search for `git.openRepositoryInParentFolders` and you can set it to `always` and it will show all of the associated repos for the Workspace.

0 commit comments

Comments
 (0)