Skip to content

Latest commit

 

History

History
103 lines (59 loc) · 7.14 KB

CONTRIBUTING.md

File metadata and controls

103 lines (59 loc) · 7.14 KB
Raw

Contributing

TL;DR

In short:

  • Known issues: See bugs and upvote using a "thumbs up" (👍) reaction.
  • VS Code bugs: Log a new issue - Include any OUTPUT window log entries from VS-IntelliCode and Python, Java or TypeScript (depending on the language you are using) with the bug.
  • Visual Studio bugs: Help > Send Feedback > Report a Problem - Repro the problem before sending and logs are automatically attached to the report.

More details below.

Upvote an existing problem report or feature request

If you're wondering if someone has already encountered a problem or requested a feature, you can look at open issues for VS Code IntelliCode or developer community for Visual Studio.

If you find that your issue already exists, feel free to make relevant comments and add your reaction on github. Use a reaction in place of a "+1" comment.

👍 - upvote

👎 - downvote

File a problem report

Step 1 - [Optional] Check output logs (VS Code)

If you're seeing an error pop up that's not descriptive and you are working in Visual Studio Code, the output logs can sometimes help you understand if this is a known issue. Simply go to the "Output" window and select the "VS IntelliCode" log stream and the "Python", "Java" or "TypeScript" log stream depending on which language you are using. Including the contents of these logs can also help us diagnose issue reports.

Step 1A - check to see if the problem has already been reported

  • For Visual Studio users, check for existing issues by searching the developer community for items relating to IntelliCode.

  • For Visual Studio Code users, search the GitHub issue repository.

Step 2A - File a Visual Studio issue (if using Visual Studio when you see the issue)

If you're using IntelliCode in Visual Studio, it has a built-in feedback mechanism via the Report a Problem tool that provides the engineering team detailed information about your installation that you should use to log bugs or problems you encounter when using VS.

Logs are automatically attached.

After your problem report is filed, it may be converted to a GitHub issue for future tracking if it applies to multiple clients or turns out to be a feature request. In this event, a link to the corresponding GitHub issue number will be referenced in comments on your raised problem report.

Check out the tips in "Writing good problem reports" for additional suggestions.

Step 2B - File a Visual Studio Code issue (if using VS Code when you see the issue)

  1. Capture logs: Go to the OUTPUT window and copy the contents of the VS IntelliCode and Python log streams after reproducing your issue.

  2. Raise a new issue: Click here to draft a new issue and please add following information into the description:

    • VS Code Version: VS Code for Mac, VS Code for Windows, and version number
    • OS and Version: Windows 7/8/8.1/10, macOS Sierra/High Sierra
    • VS IntelliCode and Python or Java Extension versions: Mention the version you installed with your VS/VSCode
    • Target Platform/Language: for example, Python, Java, or TypeScript/JavaScript
    • Repro steps: Give as much detail as you can about what you did when the bug happened, and whether you can easily reproduce it

  3. Attach logs: Paste in the logs you captured at step 1.

  4. Click Submit new issue.

Check out the tips in "Writing good problem reports" for additional suggestions.

Tip: Writing good problem reports and feature requests

Here are a few tips that will help us understand your problem or feedback quickly.

Tip

You may be able to save yourself some time by searching the issue repository to see if the problem/request already exists so you can simply up-vote it.

First, try to file a single issue per problem or request.

  • Do not enumerate multiple bugs or 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.

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

  • Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw.
  • Images, animations, or a link to a video can really help clarify what is happening.
  • 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.

Don't feel bad if we can't reproduce the issue and ask for more information! We'd rather hear about problems sooner than later.

Other ways to contact us!

Hit us up on Twitter using #vsintellicode!

Contribute to documentation

You can contribute to Visual Studio IntelliCode's documentation by submitting pull requests to this repository. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot automatically determines whether you need to provide a CLA and decorates the PR appropriately (for example, label and comment). Simply follow the instructions provided by the bot. You only need to do this once across all repos using our CLA.

Discussion etiquette

To keep the conversation clear and transparent, please limit discussion to English and keep things on topic with the issue. Be considerate to others and try to be courteous and professional at all times. This project has adopted the Microsoft Open Source Code of Conduct.

For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.