Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 1.15 KB

contributing.md

File metadata and controls

32 lines (18 loc) · 1.15 KB

Sni-ppet Contributing Guide

Hi! Thank you for joining me to build sni-ppet together.

Pull Request Guidelines

  • Checkout a topic branch from the relevant branch, e.g. master, and merge back against that branch.

  • If adding a new feature:

    • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.
  • If fixing bug:

    • Provide a detailed description of the bug in the PR. Live demo preferred.
  • It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.

  • Commit messages must follow the commit message convention so that changelogs can be automatically generated.

Development Setup

You will need Yarn/

After cloning the repo, run:

# install dependencies
yarn

Then click Run and Debug -> Debugging in Visual Stuio Code to debug the extension, more details please check out the official extension development document