Skip to content

Commit b1fae85

Browse files
authored
docs: CONTRIBUTING.md #6885
1 parent fc70e04 commit b1fae85

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

CONTRIBUTING.md

+12-10
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,11 @@ Then clone the repository and install NPM packages:
4242

4343
### Run
4444

45-
Due to the monorepo structure of the project, you must have the `aws-toolkit-vscode/packages/toolkit` folder open as root folder in the workspace.
46-
The easiest way to open the project: File > Open Workspace from File > choose `aws-toolkit-vscode/aws-toolkit-vscode.code-workspace`
45+
Due to the monorepo structure of the project, you must open the project using the
46+
`aws-toolkit-vscode.code-workspace` project file.
47+
48+
1. Run the `File: Open Workspace from File...` command in vscode.
49+
2. Select the `aws-toolkit-vscode.code-workspace` project file.
4750

4851
To run the extension from VSCode as a Node.js app:
4952

@@ -164,8 +167,7 @@ See [web.md](./docs/web.md) for working with the web mode implementation of the
164167
See [TESTPLAN.md](./docs/TESTPLAN.md) to understand the project's test
165168
structure, mechanics and philosophy.
166169
167-
You can run tests directly from VSCode. Due to the monorepo structure of the project, you must have the `aws-toolkit-vscode/packages/toolkit` folder open as root folder in the workspace.
168-
The easiest way to open the project: File > Open Workspace from File > choose `aws-toolkit-vscode/aws-toolkit-vscode.code-workspace`
170+
You can run tests directly from VSCode. Due to the monorepo structure of the project, you must [open the project via the `aws-toolkit-vscode.code-workspace` project file](#run).
169171
170172
1. Select `View > Debug`, or select the Debug pane from the sidebar.
171173
2. From the dropdown at the top of the Debug pane, select the `Extension Tests` configuration.
@@ -180,12 +182,13 @@ Tests will write logs to `./.test-reports/testLog.log`.
180182
181183
#### Run a specific test
182184
183-
To run a single test in VSCode, do any one of:
185+
To run a single test in VSCode, do any _one_ of the following:
184186
185187
- Run the _Extension Tests (current file)_ launch-config.
186-
- Use Mocha's [it.only()](https://mochajs.org/#exclusive-tests) or `describe.only()`.
187-
- Run in your terminal:
188-
188+
- Note: if you don't see this in the vscode debug menu, confirm that you opened the project
189+
[via the `aws-toolkit-vscode.code-workspace` project file](#run).
190+
- or... Use Mocha's [it.only()](https://mochajs.org/#exclusive-tests) or `describe.only()`.
191+
- or... Run in your terminal:
189192
- Unix/macOS/POSIX shell:
190193
```
191194
TEST_FILE=../core/src/test/foo.test.ts npm run test
@@ -194,8 +197,7 @@ To run a single test in VSCode, do any one of:
194197
```
195198
$Env:TEST_FILE = "../core/src/test/foo.test.ts"; npm run test
196199
```
197-
198-
- To run all tests in a particular subdirectory, you can edit
200+
- or... To run all tests in a particular subdirectory, you can edit
199201
`src/test/index.ts:rootTestsPath` to point to a subdirectory:
200202
```
201203
rootTestsPath: __dirname + '/shared/sam/debugger/'

0 commit comments

Comments
 (0)