CONTRIBUTING.md 5.4 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

A
Aaliyah Ahmed 已提交
5
There are many ways in which 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

C
ChaseKnowlden 已提交
17
See the [Feedback Channels](https://github.com/microsoft/vscode/wiki/Feedback-Channels) wiki page for details on how to share your thoughts.
E
Erich Gamma 已提交
18

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

B
Brook Riggio 已提交
21 22 23 24
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

C
ChaseKnowlden 已提交
25
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.
B
Brook Riggio 已提交
26 27 28 29 30

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

C
ChaseKnowlden 已提交
31
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.
B
Brook Riggio 已提交
32

C
ChaseKnowlden 已提交
33
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.
B
Brook Riggio 已提交
34 35 36 37 38 39 40 41 42 43 44 45 46

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 已提交
47

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

50 51
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 已提交
52
Please include the following with each issue:
E
Erich Gamma 已提交
53

54
* Version of VS Code
55

56
* Your operating system
B
Brook Riggio 已提交
57

A
Aaliyah Ahmed 已提交
58
* List of extensions that you have installed
W
Wade Anderson 已提交
59

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

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

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

B
Brook Riggio 已提交
66 67 68 69 70 71 72
* 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
73 74 75

Please remember to do the following:

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

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

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

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

### Follow Your Issue

C
ChaseKnowlden 已提交
86
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 已提交
87 88

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

90
We use GitHub Actions to help us manage issues. These Actions and their descriptions can be [viewed here](https://github.com/microsoft/vscode-github-triage-actions). Some examples of what these Actions do are:
M
Matt Bierner 已提交
91

92
* Automatically closes any issue marked `needs-more-info` if there has been no response in the past 7 days.
93 94
* Automatically lock issues 45 days after they are closed.
* Automatically implement the VS Code [feature request pipeline](https://github.com/microsoft/vscode/wiki/Issues-Triaging#managing-feature-requests).
M
Matt Bierner 已提交
95

B
Brook Riggio 已提交
96 97 98 99 100
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,
C
ChaseKnowlden 已提交
101
please see [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) in the wiki.
B
Brook Riggio 已提交
102 103 104 105

# Thank You!

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