CONTRIBUTING.md 5,6 КБ
Newer Older
Brook Riggio's avatar
Brook Riggio включено в состав коммита
1
# Contributing to VS Code
Erich Gamma's avatar
Erich Gamma включено в состав коммита
2

Brook Riggio's avatar
Brook Riggio включено в состав коммита
3
Welcome, and thank you for your interest in contributing to VS Code!
Erich Gamma's avatar
Erich Gamma включено в состав коммита
4

Jvr's avatar
Jvr включено в состав коммита
5
There are several 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.
Erich Gamma's avatar
Erich Gamma включено в состав коммита
6

Brook Riggio's avatar
Brook Riggio включено в состав коммита
7
## Asking Questions
Wade Anderson's avatar
Wade Anderson включено в состав коммита
8

Isidor Nikolic's avatar
Isidor Nikolic включено в состав коммита
9
10

Have a question? Instead of opening an issue, please ask on [Stack Overflow](https://stackoverflow.com/questions/tagged/visual-studio-code) using the tag `visual-studio-code`.
Wade Anderson's avatar
Wade Anderson включено в состав коммита
11

Brook Riggio's avatar
Brook Riggio включено в состав коммита
12
The active community will be eager to assist you. Your well-worded question will serve as a resource to others searching for help.
Erich Gamma's avatar
Erich Gamma включено в состав коммита
13

Brook Riggio's avatar
Brook Riggio включено в состав коммита
14
## Providing Feedback
Erich Gamma's avatar
Erich Gamma включено в состав коммита
15

Robin B's avatar
Robin B включено в состав коммита
16
Your comments and feedback are welcome, and the development team is available via a handful of different channels.
Wade Anderson's avatar
Wade Anderson включено в состав коммита
17

ChaseKnowlden's avatar
ChaseKnowlden включено в состав коммита
18
See the [Feedback Channels](https://github.com/microsoft/vscode/wiki/Feedback-Channels) wiki page for details on how to share your thoughts.
Erich Gamma's avatar
Erich Gamma включено в состав коммита
19

Brook Riggio's avatar
Brook Riggio включено в состав коммита
20
## Reporting Issues
Wade Anderson's avatar
Wade Anderson включено в состав коммита
21

Jvr's avatar
Jvr включено в состав коммита
22
Have you identified a reproducible problem in VS Code? Do you have a feature request? We want to hear about it! Here's how you can report your issue as effectively as possible.
Brook Riggio's avatar
Brook Riggio включено в состав коммита
23
24
25

### Identify Where to Report

ChaseKnowlden's avatar
ChaseKnowlden включено в состав коммита
26
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.
Brook Riggio's avatar
Brook Riggio включено в состав коммита
27
28
29
30
31

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

ChaseKnowlden's avatar
ChaseKnowlden включено в состав коммита
32
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.
Brook Riggio's avatar
Brook Riggio включено в состав коммита
33

ChaseKnowlden's avatar
ChaseKnowlden включено в состав коммита
34
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.
Brook Riggio's avatar
Brook Riggio включено в состав коммита
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.

Eric Cheng's avatar
Eric Cheng включено в состав коммита
47
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.
Erich Gamma's avatar
Erich Gamma включено в состав коммита
48

Robin B's avatar
Robin B включено в состав коммита
49
The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a fix.
Wade Anderson's avatar
Wade Anderson включено в состав коммита
50

MaxGrosshandler's avatar
MaxGrosshandler включено в состав коммита
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.

Brook Riggio's avatar
Brook Riggio включено в состав коммита
53
Please include the following with each issue:
Erich Gamma's avatar
Erich Gamma включено в состав коммита
54

Jackson Kearl's avatar
Jackson Kearl включено в состав коммита
55
56
* Version of VS Code
* Your operating system
Aaliyah Ahmed's avatar
Aaliyah Ahmed включено в состав коммита
57
* List of extensions that you have installed
Brook Riggio's avatar
Brook Riggio включено в состав коммита
58
59
* Reproducible steps (1... 2... 3...) that cause the issue
* What you expected to see, versus what you actually saw
Jongkeun's avatar
Jongkeun включено в состав коммита
60
* Images, animations, or a link to a video showing the issue occurring
Brook Riggio's avatar
Brook Riggio включено в состав коммита
61
62
63
64
* 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)

Kendall Pinto's avatar
Kendall Pinto включено в состав коммита
65
### Creating Pull Requests
Raymond Zhao's avatar
Raymond Zhao включено в состав коммита
66
67

* Please refer to the article on [creating pull requests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#pull-requests) and contributing to this project.
Kendall Pinto's avatar
Kendall Pinto включено в состав коммита
68

Brook Riggio's avatar
Brook Riggio включено в состав коммита
69
### Final Checklist
Wade Anderson's avatar
Wade Anderson включено в состав коммита
70
71
72

Please remember to do the following:

Brook Riggio's avatar
Brook Riggio включено в состав коммита
73
74
75
* [ ] Search the issue repository to ensure your report is a new issue
* [ ] Recreate the issue after disabling all extensions
* [ ] Simplify your code around the issue to better isolate the problem
Wade Anderson's avatar
Wade Anderson включено в состав коммита
76

Brook Riggio's avatar
Brook Riggio включено в состав коммита
77
78
79
80
Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!

### Follow Your Issue

Jvr's avatar
Jvr включено в состав коммита
81
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.
Matt Bierner's avatar
Matt Bierner включено в состав коммита
82
83

## Automated Issue Management
Brook Riggio's avatar
Brook Riggio включено в состав коммита
84

Tobias's avatar
Tobias включено в состав коммита
85
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:
Matt Bierner's avatar
Matt Bierner включено в состав коммита
86

Jvr's avatar
Jvr включено в состав коммита
87
* Automatically close any issue marked `info-needed` if there has been no response in the past 7 days.
Jackson Kearl's avatar
Jackson Kearl включено в состав коммита
88
89
* 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).
Matt Bierner's avatar
Matt Bierner включено в состав коммита
90

Brook Riggio's avatar
Brook Riggio включено в состав коммита
91
92
93
94
If you believe the bot got something wrong, please open a new issue and let us know.

## Contributing Fixes

Jvr's avatar
Jvr включено в состав коммита
95
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.
Brook Riggio's avatar
Brook Riggio включено в состав коммита
96

Alpha Romer Coma's avatar
Alpha Romer Coma включено в состав коммита
97
## Thank You
Brook Riggio's avatar
Brook Riggio включено в состав коммита
98
99

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