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
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to the Deepnote Extension for Visual Studio Code
1
+
# Contributing to the Deepnote extension for Visual Studio Code
2
2
3
3
Thank you for your interest in contributing to the Deepnote VS Code extension! This guide will help you set up your development environment and understand the contribution workflow.
First, install all the recommended VS Code extensions. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and run:
93
93
@@ -97,7 +97,7 @@ Extensions: Show Recommended Extensions
97
97
98
98
Then install all the extensions listed under "Workspace Recommendations".
99
99
100
-
#### Configure Access to @deepnote/blocksPackage
100
+
#### Configure access to @deepnote/blockspackage
101
101
102
102
The `@deepnote/blocks` package is published on GitHub Packages. To install it, you'll need to authenticate with GitHub:
103
103
@@ -147,7 +147,7 @@ python -m pip install black
147
147
148
148
```
149
149
150
-
### Incremental Build
150
+
### Incremental build
151
151
152
152
Run the `watch` build Tasks from the [Run Build Task...](https://code.visualstudio.com/docs/editor/tasks) command picker (short cut `CTRL+SHIFT+B` or `⇧⌘B`). This will leave build tasks running in the background and which will re-run as files are edited and saved. You can see the output from either task in the Terminal panel (use the selector to choose which output to look at).
153
153
@@ -173,11 +173,11 @@ npm run watch-all
173
173
Sometimes you will need to run `npm run clean` and even `rm -r out dist`.
174
174
This is especially true if you have added or removed files.
175
175
176
-
### Running the Extension
176
+
### Running the extension
177
177
178
178
After completing the setup steps, you can run the Deepnote extension in development mode:
179
179
180
-
#### Quick Start
180
+
#### Quick start
181
181
182
182
1.**Open the project in VS Code**
183
183
@@ -207,7 +207,7 @@ After completing the setup steps, you can run the Deepnote extension in developm
207
207
- In the Extension Development Host window, press `Ctrl+R` (Windows/Linux) or `Cmd+R` (macOS) to reload
208
208
- Or restart the debug session with `Ctrl+Shift+F5` / `Cmd+Shift+F5`
209
209
210
-
#### Available Debug Configurations
210
+
#### Available debug configurations
211
211
212
212
The project includes several launch configurations in `.vscode/launch.json`:
213
213
@@ -217,7 +217,7 @@ The project includes several launch configurations in `.vscode/launch.json`:
217
217
-**Unit Tests** - Run unit tests without VS Code
218
218
-**Tests (Jupyter+Python Extension installed)** - Run integration tests
219
219
220
-
#### Debugging Tips
220
+
#### Debugging tips
221
221
222
222
<details>
223
223
<summary>Click to expand debugging tips</summary>
@@ -251,7 +251,7 @@ Edit `.vscode/launch.json` and add environment variables:
251
251
252
252
</details>
253
253
254
-
### Errors and Warnings
254
+
### Errors and warnings
255
255
256
256
TypeScript errors and warnings will be displayed in the `Problems` window of Visual Studio Code.
257
257
@@ -262,7 +262,7 @@ Then, open the debug panel by clicking the `Run and Debug` icon on the sidebar,
262
262
option from the top menu, and click start. A new window will launch with the title
263
263
`[Extension Development Host]`.
264
264
265
-
### Running Unit Tests
265
+
### Running unit tests
266
266
267
267
Note: Unit tests are those in files with extension `.unit.test.ts`.
268
268
@@ -290,7 +290,7 @@ Alter the `launch.json` file in the `"Debug Unit Tests"` section by setting the
290
290
291
291
...this will only run the suite with the tests you care about during a test run (be sure to set the debugger to run the `Debug Unit Tests` launcher).
292
292
293
-
### Running Integration Tests (with VS Code)
293
+
### Running integration tests (with VS Code)
294
294
295
295
Note: Integration tests are those in files with extension `*.vscode.test*.ts`.
296
296
@@ -305,7 +305,7 @@ You can also run the tests from the command-line (after compiling):
305
305
npm run testVSCode # will launch the VSC UI
306
306
```
307
307
308
-
#### Customising the Test Run
308
+
#### Customising the test run
309
309
310
310
If you want to change which tests are run or which version of Python is used,
311
311
you can do this by setting environment variables. The same variables work when
@@ -368,7 +368,7 @@ setting a single variable for a subprocess:
368
368
VSC_JUPYTER_CI_TEST_GREP=Sorting npm run testVSCode
369
369
```
370
370
371
-
### Testing Python Scripts
371
+
### Testing Python scripts
372
372
373
373
The extension has a number of scripts in ./pythonFiles. Tests for these
374
374
scripts are found in ./pythonFiles/tests. To run those tests:
@@ -384,11 +384,11 @@ To run only the functional tests:
384
384
385
385
`python3 -m pythonFiles.tests --functional`
386
386
387
-
### Standard Debugging
387
+
### Standard debugging
388
388
389
389
Clone the repo into any directory, open that directory in VSCode, and use the `Extension` launch option within VSCode.
390
390
391
-
### Coding Standards
391
+
### Coding standards
392
392
393
393
Messages displayed to the user must be localized using/created constants from/in the [localize.ts](https://github.com/Microsoft/vscode-jupyter/blob/main/src/platform/common/utils/localize.ts) file.
394
394
@@ -401,7 +401,7 @@ smoothly, but it allows you to help out by noticing when a step is
401
401
missed or to learn in case someday you become a project maintainer as
402
402
well!
403
403
404
-
### Folder Structure
404
+
### Folder structure
405
405
406
406
At a high level we have a bunch of folders. Each high level is described in this wiki [page](https://github.com/deepnote/vscode-deepnote/wiki/Source-Code-Organization)
407
407
@@ -481,7 +481,7 @@ Overall steps for releasing are covered in the
481
481
482
482
To create a release _build_, follow the steps outlined in the [release plan](https://github.com/Microsoft/vscode-jupyter/labels/release%20plan) (which has a [template](https://github.com/Microsoft/vscode-jupyter/blob/main/.github/release_plan.md)).
483
483
484
-
## Local Build
484
+
## Local build
485
485
486
486
Steps to build the extension on your machine once you've cloned the repo:
0 commit comments