Skip to content

Commit 095120a

Browse files
committed
fix: heading style
1 parent 5490f3d commit 095120a

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff 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
22

33
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.
44

@@ -87,7 +87,7 @@ git clone https://github.com/deepnote/vscode-deepnote
8787
cd vscode-deepnote
8888
```
8989

90-
#### Install Recommended Extensions
90+
#### Install recommended extensions
9191

9292
First, install all the recommended VS Code extensions. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P) and run:
9393

@@ -97,7 +97,7 @@ Extensions: Show Recommended Extensions
9797

9898
Then install all the extensions listed under "Workspace Recommendations".
9999

100-
#### Configure Access to @deepnote/blocks Package
100+
#### Configure access to @deepnote/blocks package
101101

102102
The `@deepnote/blocks` package is published on GitHub Packages. To install it, you'll need to authenticate with GitHub:
103103

@@ -147,7 +147,7 @@ python -m pip install black
147147

148148
```
149149

150-
### Incremental Build
150+
### Incremental build
151151

152152
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).
153153

@@ -173,11 +173,11 @@ npm run watch-all
173173
Sometimes you will need to run `npm run clean` and even `rm -r out dist`.
174174
This is especially true if you have added or removed files.
175175

176-
### Running the Extension
176+
### Running the extension
177177

178178
After completing the setup steps, you can run the Deepnote extension in development mode:
179179

180-
#### Quick Start
180+
#### Quick start
181181

182182
1. **Open the project in VS Code**
183183

@@ -207,7 +207,7 @@ After completing the setup steps, you can run the Deepnote extension in developm
207207
- In the Extension Development Host window, press `Ctrl+R` (Windows/Linux) or `Cmd+R` (macOS) to reload
208208
- Or restart the debug session with `Ctrl+Shift+F5` / `Cmd+Shift+F5`
209209

210-
#### Available Debug Configurations
210+
#### Available debug configurations
211211

212212
The project includes several launch configurations in `.vscode/launch.json`:
213213

@@ -217,7 +217,7 @@ The project includes several launch configurations in `.vscode/launch.json`:
217217
- **Unit Tests** - Run unit tests without VS Code
218218
- **Tests (Jupyter+Python Extension installed)** - Run integration tests
219219

220-
#### Debugging Tips
220+
#### Debugging tips
221221

222222
<details>
223223
<summary>Click to expand debugging tips</summary>
@@ -251,7 +251,7 @@ Edit `.vscode/launch.json` and add environment variables:
251251

252252
</details>
253253

254-
### Errors and Warnings
254+
### Errors and warnings
255255

256256
TypeScript errors and warnings will be displayed in the `Problems` window of Visual Studio Code.
257257

@@ -262,7 +262,7 @@ Then, open the debug panel by clicking the `Run and Debug` icon on the sidebar,
262262
option from the top menu, and click start. A new window will launch with the title
263263
`[Extension Development Host]`.
264264

265-
### Running Unit Tests
265+
### Running unit tests
266266

267267
Note: Unit tests are those in files with extension `.unit.test.ts`.
268268

@@ -290,7 +290,7 @@ Alter the `launch.json` file in the `"Debug Unit Tests"` section by setting the
290290

291291
...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).
292292

293-
### Running Integration Tests (with VS Code)
293+
### Running integration tests (with VS Code)
294294

295295
Note: Integration tests are those in files with extension `*.vscode.test*.ts`.
296296

@@ -305,7 +305,7 @@ You can also run the tests from the command-line (after compiling):
305305
npm run testVSCode # will launch the VSC UI
306306
```
307307

308-
#### Customising the Test Run
308+
#### Customising the test run
309309

310310
If you want to change which tests are run or which version of Python is used,
311311
you can do this by setting environment variables. The same variables work when
@@ -368,7 +368,7 @@ setting a single variable for a subprocess:
368368
VSC_JUPYTER_CI_TEST_GREP=Sorting npm run testVSCode
369369
```
370370

371-
### Testing Python Scripts
371+
### Testing Python scripts
372372

373373
The extension has a number of scripts in ./pythonFiles. Tests for these
374374
scripts are found in ./pythonFiles/tests. To run those tests:
@@ -384,11 +384,11 @@ To run only the functional tests:
384384

385385
`python3 -m pythonFiles.tests --functional`
386386

387-
### Standard Debugging
387+
### Standard debugging
388388

389389
Clone the repo into any directory, open that directory in VSCode, and use the `Extension` launch option within VSCode.
390390

391-
### Coding Standards
391+
### Coding standards
392392

393393
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.
394394

@@ -401,7 +401,7 @@ smoothly, but it allows you to help out by noticing when a step is
401401
missed or to learn in case someday you become a project maintainer as
402402
well!
403403

404-
### Folder Structure
404+
### Folder structure
405405

406406
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)
407407

@@ -481,7 +481,7 @@ Overall steps for releasing are covered in the
481481

482482
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)).
483483

484-
## Local Build
484+
## Local build
485485

486486
Steps to build the extension on your machine once you've cloned the repo:
487487

0 commit comments

Comments
 (0)