vscode/CONTRIBUTING.md
2016-08-18 15:50:31 +02:00

2.5 KiB

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. Therefore:

  • Provide reproducible steps, what the result of the steps was, and what you would have expected.
  • A description of what you expect to happen
  • Animated GIFs
  • Code that demonstrates the issue, when providing a code snippet also include it in source and not only as an image
  • Version of VS Code
  • Errors in the Dev Tools Console (Help | Toggle Developer Tools)
  • When you have extensions installed, can you reproduce the issue when starting vscode without extensions by using the --disable-extensions command line argument?

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.