Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.2 KB

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.

Development

Installation Prerequisites:

Steps

  1. Fork and clone this repository

  2. cd vscode-kafka/

  3. Install the dependencies:

    $ npm install
  4. Compile with webpack :

    $ npm run compile

This step is required since vscode-kafka uses vscode-wizard to create / edit a cluster. vscode-wizard is a NPM module which embeds some html, js, css resources in pages folder. As vscode-kafka is built with webpack, this pages folder must be copied from the vscode-wizard/pages NPM module to vscode-kafka/pages.

  1. To run the extension, open the Debugging tab in VSCode.
  2. Select and run 'Launch Extension (vscode-kafka)' at the top left.