Skip to content

How to Contribute

Marlom Girardi edited this page Oct 16, 2022 · 2 revisions

Contributing to Keep Context for VSCode

There are many ways to contribute to the project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.

After cloning and building the repo, check out the issues list. Issues labeled help wanted are good issues to submit a PR for.

Prerequisites

  • Node.JS (latest LTS)
  • NPM
cd vscode-keep-context;
npm install;

Build

On the file package.json you will find all the commands that you need to build the extension.

  • npm compile for production
  • npm watch for development

Run

Using VS Code you have everything out of the box on the debug section of your VS Code. Using the debug, you will be able to run a VS Code instance with the extension enabled in many situations with a debugger attached.

Automated Testing

⚠️ TODO 🤷‍♂️

Linting

We use ESLint for linting the code. You can run ESLint using npm run lint from your terminal.

Clone this wiki locally