Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 3.13 KB
Raw

Contributing Issues

Before Submitting an Issue

First, please do a search in open issues to see if the issue or feature request has already been filed. Use this query to search for the most popular feature requests.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment.

👍 - upvote

👎 - downvote

The VS Code project is distributed across multiple repositories, try to file the issue against the correct repository Related Projects.

If your issue is a question then please ask the question on Stack Overflow using the tag vscode.

If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below.

Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request.

  • Do not enumerate multiple bugs or feature requests in the same issue.
  • Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix.

Please include the following with each issue.

  • Version of VS Code
  • List of extensions that you have installed.

Tip: You can easily add the list of extensions by creating the issue using Report Issues from VS Code's Help menu.

  • Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw.
  • Images, animations, or a link to a video.
  • A code snippet that demonstrates the issue or a link to a code repository we can easily pull down onto our machine to recreate the issue.

Note: Because we need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient.

  • Errors in the Dev Tools Console (Help | Toggle Developer Tools)

Please remember to do the following:

  • Search the issue repository to see if there exists a duplicate.
  • Recreate the issue after disabling all extensions (see the docs for how to do this). If you find the issue is caused by an extension you have installed please file an issue on the extension respectively.
  • Simplify your code around the issue so we can better isolate the problem.

Don't feel bad if we can't reproduce the issue and ask for more information!

Finally, this is our issue tracking work flow that describes what happens once you submitted an issue.

Contributing Fixes

If you are interested in fixing issues and contributing directly to the code base, please see the document How to Contribute.