Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.56 KB

Contributing

All kinds of contributions for improving the Kusion experience on VS Code are welcomed.

This guide will explain the process to set up your development environment to work on the VS Code Kusion extension.

Developing

Set Up the Environment

  1. Install node.

  2. Install VS Code 1.50+

  3. Clone the repository and run npm install:

git clone https://github.com/KusionStack/vscode-kusion.git
cd vscode-kusion
npm install
code .

Run

To run the extension, open the project with VS Code and open the Run view (Command+Shift+D), select Run Extension, and press F5. This will compile and run the extension in a new Extension Development Host window, in which you can create a Konfig project and add some .k files to play with.

Compile and Publish

  • You can compile the project by executing the following command:

    npm run compile
  • To publish the extension to the VS Code extension market, you need to first build an extension package and then publish it:

    vsce package --baseImagesUrl https://github.com/KusionStack/vscode-kusion.git
    vsce publish --baseImagesUrl https://github.com/KusionStack/vscode-kusion.git

Reference