Contributing to the Live Preview Extension
There are many ways to contribute to the Visual Studio Code Live Preview project: logging bugs, submitting pull requests, reporting issues, and creating suggestions.
After cloning and building the repo, check out the issues list.
Getting the sources
First, fork the Live Preview repository so that you can make a pull request. Then, clone your fork locally:
git clone https://github.com/<<<your-github-account>>>/vscode-livepreview.git
Occasionally you will want to merge changes in the upstream repository (the official code repo) with your fork.
cd vscode-livepreview
git checkout main
git pull https://github.com/microsoft/vscode-livepreview.git main
Manage any merge conflicts, commit them, and then push them to your fork.
Prerequisites
In order to download necessary tools, clone the repository, and install dependencies via yarn you need network access.
You'll need the following tools:
cd vscode-livepreview
npm install
Build and Run
After cloning the extension and running npm install, use the debugger in VS Code to execute "Run Extension".
Linting/Formatting
We use eslint for linting our sources. You can format the the sources by calling npm run format from a terminal or command prompt.
To lint the source as you make changes you can install the eslint extension.
Work Branches
Even if you have push rights on the Microsoft/vscode-livepreview repository, you should create a personal fork and create feature branches there when you need them. This keeps the main repository clean and your personal workflow cruft out of sight.
Pull Requests
Before we can accept a pull request from you, you'll need to sign a Contributor License Agreement (CLA). It is an automated process and you only need to do it once.
To enable us to quickly review and accept your pull requests, always create one pull request per issue and link the issue in the pull request. Never merge multiple requests in one unless they have the same root cause. Be sure to keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible.
Suggestions
We're also interested in your feedback for the future of Live Preview. You can submit a suggestion or feature request through the issue tracker. To make this process more effective, we're asking that these include more information to help define them more clearly.
Discussion Etiquette
In order to keep the conversation clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times.