From e5d833cab9952bbd7741b68f676e3f00d8399fe6 Mon Sep 17 00:00:00 2001 From: Wade Anderson Date: Wed, 4 Jan 2017 11:46:17 -0800 Subject: [PATCH] Added a link to disable an extension doc --- CONTRIBUTING.md | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e271f409c7a..69b0fa8a7f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,15 +22,22 @@ 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. -The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. Therefore: +The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. + +Please include the following with each issue. -* Provide reproducible steps, what the result of the steps was, and what you would have expected. -* A description of what you expect to happen -* Animated GIFs -* Code that demonstrates the issue, when providing a code snippet also include it in source and not only as an image * Version of VS Code +* List of extensions that you have installed. +* Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw. +* Images, animations, or a link to a video. +* 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. * Errors in the Dev Tools Console (Help | Toggle Developer Tools) -* When you have extensions installed, can you reproduce the issue when starting vscode without extensions by using the `--disable-extensions` command line argument? + +Please remember to do the following: + +* Search the issue repository to see if there exists a duplicate. +* Recreate the issue after disabling all extensions (see the [docs for how to do this](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 respectively. +* Simplify your code around the issue so we can better isolate the problem. Don't feel bad if we can't reproduce the issue and ask for more information!