Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.56 KB
Raw

Contributing to the Notebook Renderers extension for Visual Studio Code

Contributing a pull request

Prerequisites

  1. Node.js 14
  2. npm 6.13.4
  3. Windows, macOS, or Linux
  4. Visual Studio Code
  5. The following VS Code extensions:

Setup

git clone https://github.com/DonJayamanne/typescript-notebook
cd typescript-notebook
npm ci

If you see warnings that The engine "vscode" appears to be invalid., you can ignore these.

Incremental Build

Run the Build build Tasks from the Run Build Task... command picker (short cut CTRL+SHIFT+B or ⇧⌘B). This will leave build task 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).

For incremental builds you can use the following commands depending on your needs:

npm run dev

Errors and Warnings

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

Local Build

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

> npm install -g vsce
> npm ci
> npm run package