CONTRIBUTING.md

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Initial set up

To start off, fork this repo on GitHub.

Clone the forked repo

Once the repo is forked, clone your fork locally using one of the following methods.

Using SSH

git clone git@github.com:{your-github-username}/vscode-webview-ui-toolkit-samples.git

Using HTTPS

git clone https://github.com/{your-github-username}/vscode-webview-ui-toolkit-samples.git

Using GitHub CLI

gh repo clone {your-github-username}/vscode-webview-ui-toolkit-samples

Set an upstream remote

Next, add an upstream remote pointing to the primary toolkit sample repo.

cd vscode-webview-ui-toolkit-samples/
git remote add upstream https://github.com/microsoft/vscode-webview-ui-toolkit-samples.git
git fetch upstream main

Create a branch

Create a branch for local development. Once that is complete, you can start making your changes locally.

git checkout -b {branch-name}

Add and commit changes

Commit your changes and push your branch to GitHub.

git add .
git commit -m "Detailed description of your changes."

Pull any upstream changes

If there are new commits from upstream's main branch since your last git pull, you need to merge the latest commits from upstream's main into your branch and resolve any merge conflicts locally.

If there are no new commits from upstream's main, you can skip the following steps.

1. Get the latest commits.

   git checkout main
   git pull --rebase upstream main
   

2. Merge the latest commits into your branch.

   git checkout {branch-name}
   git merge main
   

Push local changes

Push your branch to GitHub.

git push origin {branch-name}

Submit a pull request

Finally, submit a pull request to the main toolkit sample repository through the GitHub website.

Long term repo maintenance

Once your branch has been merged into upstream's main branch, if you want to keep your remote and local repo clean, you can delete your branch.

git push origin --delete {branch-name}
git branch -D {branch-name}

Finally, you can keep your fork's main branch up-to-date with upstream's main branch.

git checkout main
git pull --rebase upstream main
git push origin main