CONTRIBUTING.md 2.9 KB
Newer Older
E
Erich Gamma 已提交
1 2 3
## Contributing Issues

### Before Submitting an Issue
E
Erich Gamma 已提交
4 5 6
First, please do a search in [open issues](https://github.com/Microsoft/vscode/issues) to see if the issue or feature request has already been filed. Use this [query](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) to search for the most popular feature requests.

If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment.
E
Erich Gamma 已提交
7

8 9 10 11 12
👍 - upvote

👎 - downvote

The VS Code project is distributed across multiple repositories, try to file the issue against the correct repository [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects).
E
Erich Gamma 已提交
13

D
Daniel Imms 已提交
14
If your issue is a question then please ask the question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) using the tag `vscode`.
E
Erich Gamma 已提交
15

E
Erich Gamma 已提交
16
If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below.
17

E
Erich Gamma 已提交
18 19
## Writing Good Bug Reports and Feature Requests

20 21
File a single issue per problem and feature request.

E
Erich Gamma 已提交
22
* Do not enumerate multiple bugs or feature requests in the same issue.
23
* 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.
E
Erich Gamma 已提交
24

25 26 27
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. 
E
Erich Gamma 已提交
28 29

* Version of VS Code
30 31 32 33
* List of extensions that you have installed. 
* 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. 
E
Erich Gamma 已提交
34
* Errors in the Dev Tools Console (Help | Toggle Developer Tools)
35 36 37 38 39 40

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](https://code.visualstudio.com/docs/editor/extension-gallery#_disable-an-extension)). 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. 
E
Erich Gamma 已提交
41

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

Finally, this is our [issue tracking](https://github.com/Microsoft/vscode/wiki/Issue-Tracking) work flow that describes what happens once you submitted an issue.

46 47
## Contributing Fixes
If you are interested in fixing issues and contributing directly to the code base,
D
Daniel Imms 已提交
48
please see the document [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute).