Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 2.02 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.

Development

Installation Prerequisites:

Steps

  1. Fork and clone this repository

  2. Change to the directory:

  $ cd vscode-granite
  1. Install the NPM dependencies:
  $ npm run install:ci

This will install the dependencies for the extension and its webview(s)

  1. To run the extension, open the Debugging tab in VSCode.

  2. Select and run 'Launch Extension' at the top left:

Build the extension

You can package the extension as a *.vsix archive:

$ npx @vscode/vsce package

It will generate a vscode-granite-<version>.vsix

You can then install it in VS Code by following these instructions.

Contribute changes

Try to follow this workflow to contribute changes:

  1. Fork the repository and clone your fork
  2. Create a new branch
  3. Make your changes in that branch
  4. Commit and sign your commit (with the -s flag)
  5. Push your branch up to your fork on GitHub
  6. Open a pull request with a detailed description of your changes

With regards to git history, please:

  • keep the git history linear, no merge commits.
  • ensure PRs are squashed before merging, to keep changes atomic.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.