CONTRIBUTING.md 5.1 KB
Newer Older
B
Brook Riggio 已提交
1
# Contributing to VS Code
E
Erich Gamma 已提交
2

B
Brook Riggio 已提交
3
Welcome, and thank you for your interest in contributing to VS Code!
E
Erich Gamma 已提交
4

B
Brook Riggio 已提交
5
There are many ways that you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.
E
Erich Gamma 已提交
6

B
Brook Riggio 已提交
7
## Asking Questions
8

B
Brook Riggio 已提交
9
Have a question? Rather than opening an issue, please ask away on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) using the tag `vscode`.
10

B
Brook Riggio 已提交
11
The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.
E
Erich Gamma 已提交
12

B
Brook Riggio 已提交
13
## Providing Feedback
E
Erich Gamma 已提交
14

15
Your comments and feedback are welcome, and the development team is available via a handful of different channels.
16

B
Brook Riggio 已提交
17
See the [Feedback Channels](https://github.com/Microsoft/vscode/wiki/Feedback-Channels) wiki page for details about how to share your thoughts.
E
Erich Gamma 已提交
18

B
Brook Riggio 已提交
19
## Reporting Issues
20

B
Brook Riggio 已提交
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
Have you identified a reproducible problem in VS Code? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible.

### Identify Where to Report

The VS Code project is distributed across multiple repositories. Try to file the issue against the correct repository. Check the list of [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects) if you aren't sure which repo is correct.

Can you recreate the issue even after [disabling all extensions](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's repo directly.

### Look For an Existing Issue

Before you create a new issue, 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.

Be sure to scan through the [most popular](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) 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:

* 👍 - upvote
* 👎 - downvote


If you cannot find an existing issue that describes your bug or feature, create a new 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.
E
Erich Gamma 已提交
48

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

51 52
The built-in tool for reporting an issue, which you can access by using `Report Issue` in VS Code's Help menu, can help streamline this process by automatically providing the version of VS Code, all your installed extensions, and your system info. Additionally, the tool will search among existing issues to see if a similar issue already exists.

B
Brook Riggio 已提交
53
Please include the following with each issue:
E
Erich Gamma 已提交
54 55

* Version of VS Code
B
Brook Riggio 已提交
56

M
Matt Bierner 已提交
57
* List of extensions that you have installed.
W
Wade Anderson 已提交
58

B
Brook Riggio 已提交
59
* Reproducible steps (1... 2... 3...) that cause the issue
W
Wade Anderson 已提交
60

B
Brook Riggio 已提交
61
* What you expected to see, versus what you actually saw
W
Wade Anderson 已提交
62

63
* Images, animations, or a link to a video showing the issue occurring
W
Wade Anderson 已提交
64

B
Brook Riggio 已提交
65 66 67 68 69 70 71
* A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally

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

* Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools)

### Final Checklist
72 73 74

Please remember to do the following:

B
Brook Riggio 已提交
75
* [ ] Search the issue repository to ensure your report is a new issue
E
Erich Gamma 已提交
76

B
Brook Riggio 已提交
77
* [ ] Recreate the issue after disabling all extensions
78

B
Brook Riggio 已提交
79
* [ ] Simplify your code around the issue to better isolate the problem
80

B
Brook Riggio 已提交
81 82 83 84
Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!

### Follow Your Issue

M
MarvinJWendt 已提交
85
Once submitted, your report will go into the [issue tracking](https://github.com/Microsoft/vscode/wiki/Issue-Tracking) workflow. Be sure to understand what will happen next, so you know what to expect, and how to continue to assist throughout the process.
M
Matt Bierner 已提交
86 87

## Automated Issue Management
B
Brook Riggio 已提交
88

M
Matt Bierner 已提交
89 90
We use a bot to help us manage issues. This bot currently:

91 92
* Automatically closes any issue marked `needs-more-info` if there has been no response in the past 7 days.
* Automatically locks issues 45 days after they are closed.
M
Matt Bierner 已提交
93

B
Brook Riggio 已提交
94 95 96 97 98 99 100 101 102 103 104
If you believe the bot got something wrong, please open a new issue and let us know.

## Contributing Fixes

If you are interested in writing code to fix issues,
please see [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute) in the wiki.

# Thank You!

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.