Update CONTRIBUTING.md (#3)

This commit is contained in:
Karl Burtram
2017-11-13 13:41:50 -08:00
committed by GitHub
parent 38d8eaad50
commit 939611d619

View File

@@ -1,7 +1,7 @@
## Contributing Issues ## Contributing Issues
### Before Submitting an Issue ### Before Submitting an Issue
First, 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. Use this [query](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) to search for the most popular feature requests. First, please do a search in [open issues](https://github.com/Microsoft/sqlopsstudio/issues) to see if the issue or feature request has already been filed. Use this [query](https://github.com/Microsoft/sqlopsstudio/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc) to search for the most popular feature requests.
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. 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.
@@ -9,10 +9,6 @@ If you find your issue already exists, make relevant comments and add your [reac
👎 - downvote 👎 - downvote
The VS Code project is distributed across multiple repositories, try to file the issue against the correct repository [Related Projects](https://github.com/Microsoft/vscode/wiki/Related-Projects).
If your issue is a question then please ask the question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) using the tag `vscode`.
If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below. If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below.
## Writing Good Bug Reports and Feature Requests ## Writing Good Bug Reports and Feature Requests
@@ -26,10 +22,9 @@ The more information you can provide, the more likely someone will be successful
Please include the following with each issue. Please include the following with each issue.
* Version of VS Code * Version of SQL Ops Studio
* List of extensions that you have installed.
> **Tip:** You can easily add the list of extensions by creating the issue using `Report Issues` from VS Code's Help menu. > **Tip:** You can easily create an issue using `Report Issues` from SQL Operations Studio Help menu.
* Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw. * Reproducible steps (1... 2... 3...) and what you expected versus what you actually saw.
* Images, animations, or a link to a video. * Images, animations, or a link to a video.
@@ -42,13 +37,10 @@ Please include the following with each issue.
Please remember to do the following: Please remember to do the following:
* Search the issue repository to see if there exists a duplicate. * 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 scripts around the issue so we can better isolate the problem.
* 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! Don't feel bad if we can't reproduce the issue and ask for more information!
Finally, this is our [issue tracking](https://github.com/Microsoft/vscode/wiki/Issue-Tracking) work flow that describes what happens once you submitted an issue.
## Contributing Fixes ## Contributing Fixes
If you are interested in fixing issues and contributing directly to the code base, If you are interested in fixing issues and contributing directly to the code base,
please see the document [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute). please see the document [How to Contribute](https://github.com/Microsoft/sqlopsstudio/wiki/How-to-Contribute).