Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

49 lines (40 loc) · 1.96 KB
Raw

How to contribute

Contributions are essential for keeping this extension great. We try to keep it as easy as possible to contribute changes and we are open to suggestions for making it even easier. There are only a few guidelines that we need contributors to follow.

First Time Setup

  1. Install prerequisites:

  2. Fork and clone the repository

  3. cd vscode-knative

  4. Install the dependencies:

    $ npm install

  5. Open the folder in VS Code

Developing the extension

We strongly suggest that you use esbenp.prettier-vscode and dbaeumer.vscode-eslint to ease the development of the extension. We are using multiple tools to keep codebase clean, maintainable and code readable.

  1. Once you have all package dependencies installed (npm install) you can compile the extension, so you are sure you have all the dependencies installed correctly: 
    npm run build
  2. Now you can run unit tests suite by going to the Run tab and launching Extension Tests (vscode-knative) task.
  3. Or you can run tests from the CLI: 
    npm test
  4. To run extension in VSCode using the code directly from the workspace, launch Run Extension (vscode-knative) task.

Installing the extension from the source code

  1. Install vsce - A command line tool you'll use to publish extensions to the Extension Marketplace.

    $ npm install -g vsce

  2. From root folder, run the below command.

    $ vsce package

  3. vscode-knative-<version>.vsix file is created. Install it by following the instructions here.

  4. Once the extension is installed and reloaded, there will be an Knative Icon on the View Container.

If you have any questions or run into any problems, please post an issue - we'll be very happy to help.