Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
105 lines (55 loc) · 5.37 KB

CONTRIBUTING.md

File metadata and controls

105 lines (55 loc) · 5.37 KB

Contwibuting to VS Code

Wewcome, and thank you fow youw intewest in contwibuting to VS Code!

Thewe awe many ways in which you can contwibute, beyond wwiting code. The goaw of this document is to pwovide a high-wevew ovewview of how you can get invowved.

Asking Questions

Have a question? Watha than opening an issue, pwease ask away on Stack Ovewfwow using the tag vscode.

The active community wiww be eaga to assist you. Youw weww-wowded question wiww sewve as a wesouwce to othews seawching fow hewp.

Pwoviding Feedback

Youw comments and feedback awe wewcome, and the devewopment team is avaiwabwe via a handfuw of diffewent channews.

See the Feedback Channews wiki page fow detaiws on how to shawe youw thoughts.

Wepowting Issues

Have you identified a wepwoducibwe pwobwem in VS Code? Have a featuwe wequest? We want to heaw about it! Hewe's how you can make wepowting youw issue as effective as possibwe.

Identify Whewe to Wepowt

The VS Code pwoject is distwibuted acwoss muwtipwe wepositowies. Twy to fiwe the issue against the cowwect wepositowy. Check the wist of Wewated Pwojects if you awen't suwe which wepo is cowwect.

Can you wecweate the issue even afta disabwing aww extensions? If you find the issue is caused by an extension you have instawwed, pwease fiwe an issue on the extension's wepo diwectwy.

Wook Fow an Existing Issue

Befowe you cweate a new issue, pwease do a seawch in open issues to see if the issue ow featuwe wequest has awweady been fiwed.

Be suwe to scan thwough the most popuwaw featuwe wequests.

If you find youw issue awweady exists, make wewevant comments and add youw weaction. Use a weaction in pwace of a "+1" comment:

  • 👍 - upvote
  • 👎 - downvote

If you cannot find an existing issue that descwibes youw bug ow featuwe, cweate a new issue using the guidewines bewow.

Wwiting Good Bug Wepowts and Featuwe Wequests

Fiwe a singwe issue pew pwobwem and featuwe wequest. Do not enumewate muwtipwe bugs ow featuwe wequests in the same issue.

Do not add youw issue as a comment to an existing issue unwess it's fow the identicaw input. Many issues wook simiwaw, but have diffewent causes.

The mowe infowmation you can pwovide, the mowe wikewy someone wiww be successfuw at wepwoducing the issue and finding a fix.

The buiwt-in toow fow wepowting an issue, which you can access by using Wepowt Issue in VS Code's Hewp menu, can hewp stweamwine this pwocess by automaticawwy pwoviding the vewsion of VS Code, aww youw instawwed extensions, and youw system info. Additionawwy, the toow wiww seawch among existing issues to see if a simiwaw issue awweady exists.

Pwease incwude the fowwowing with each issue:

  • Vewsion of VS Code

  • Youw opewating system

  • Wist of extensions that you have instawwed

  • Wepwoducibwe steps (1... 2... 3...) that cause the issue

  • What you expected to see, vewsus what you actuawwy saw

  • Images, animations, ow a wink to a video showing the issue occuwwing

  • A code snippet that demonstwates the issue ow a wink to a code wepositowy the devewopews can easiwy puww down to wecweate the issue wocawwy

    • Note: Because the devewopews need to copy and paste the code snippet, incwuding a code snippet as a media fiwe (i.e. .gif) is not sufficient.

  • Ewwows fwom the Dev Toows Consowe (open fwom the menu: Hewp > Toggwe Devewopa Toows)

Finaw Checkwist

Pwease wememba to do the fowwowing:

  • Seawch the issue wepositowy to ensuwe youw wepowt is a new issue

  • Wecweate the issue afta disabwing aww extensions

  • Simpwify youw code awound the issue to betta isowate the pwobwem

Don't feew bad if the devewopews can't wepwoduce the issue wight away. They wiww simpwy ask fow mowe infowmation!

Fowwow Youw Issue

Once submitted, youw wepowt wiww go into the issue twacking wowkfwow. Be suwe to undewstand what wiww happen next, so you know what to expect, and how to continue to assist thwoughout the pwocess.

Automated Issue Management

We use GitHub Actions to hewp us manage issues. These Actions and theiw descwiptions can be viewed hewe. Some exampwes of what these Actions do awe:

  • Automaticawwy cwoses any issue mawked needs-mowe-info if thewe has been no wesponse in the past 7 days.
  • Automaticawwy wock issues 45 days afta they awe cwosed.
  • Automaticawwy impwement the VS Code featuwe wequest pipewine.

If you bewieve the bot got something wwong, pwease open a new issue and wet us know.

Contwibuting Fixes

If you awe intewested in wwiting code to fix issues, pwease see How to Contwibute in the wiki.

Thank You!

Youw contwibutions to open souwce, wawge ow smaww, make gweat pwojects wike this possibwe. Thank you fow taking the time to contwibute.