CONTRIBUTING.md

Contributing to this extension

Code contributions, bug reports, and feedback are very welcome. These should be submitted through the GitHub repository.

• Setting up Locally
• Releasing a New Version

Setting up Locally

You can clone this repo and then run the extension in development mode in VS Code.

Prerequisites

• Node
• VS Code

Setup

1. Install the Node dependencies:

   npm install
   

2. Open the directory in VS Code and launch the extension from the Run panel.

The extension source code can be found in src/extension.ts.

Releasing a New Version

These are the steps to take to release a new version of the extension (for contributors who have push access to the GitHub repo).

Prior to Release

1. Check the milestone on GitHub for open issues or PRs. Fix or reassign as necessary.
2. Ensure readme.md contains an up to date description, FAQs, screenshots, etc.
3. Ensure .vscodeignore is up to date with all files that shouldn't be part of the build.
4. Prepare a changelog for the Releases page on GitHub.
   • The git changelog -x command from Git Extras is handy for this.

For Release

1. Ensure you're on the develop branch and all the changes for this release have been merged in.
2. Bump the version number:
   • npm version patch for a patch release (1.2.3 => 1.2.4)
   • npm version minor for a minor release (1.2.3 => 1.3.0)
   • npm version major for a major release (1.2.3 => 2.0.0)
3. git push origin develop
4. git checkout trunk
5. git merge develop
6. git push origin trunk
7. git push origin trunk:master (VS Marketplace uses images from the master branch)
8. git push origin --tags
9. Enter the changelog into the release on GitHub and publish it.

Publishing a release on GitHub triggers an action which deploys the release to the VS Marketplace. No need to touch vsce.

Manual Deployment

If necessary, manual deployment to the VS Marketplace can be done with:

npm run deploy