vscode/CONTRIBUTING.md

42 lines
2.5 KiB
Markdown
Raw Normal View History

2015-12-10 14:36:26 +00:00
## Contributing Issues
### Before Submitting an Issue
2016-08-18 13:49:31 +00:00
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.
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.
2015-12-10 14:36:26 +00:00
👍 - upvote
👎 - 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).
2015-12-10 14:36:26 +00:00
If your issue is a question then please ask the question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode) using the tag `vscode`.
2015-12-10 14:36:26 +00:00
2016-08-18 13:49:31 +00:00
If you cannot find an existing issue that describes your bug or feature, submit an issue using the guidelines below.
2015-12-10 14:36:26 +00:00
## Writing Good Bug Reports and Feature Requests
File a single issue per problem and feature request.
2016-08-18 13:49:31 +00:00
* 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.
2015-12-10 14:36:26 +00:00
The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. Therefore:
2016-07-15 14:05:52 +00:00
* Provide reproducible steps, what the result of the steps was, and what you would have expected.
2016-08-18 13:49:31 +00:00
* A description of what you expect to happen
2015-12-10 14:36:26 +00:00
* Animated GIFs
2016-08-18 13:49:31 +00:00
* Code that demonstrates the issue, when providing a code snippet also include it in source and not only as an image
2015-12-10 14:36:26 +00:00
* Version of VS Code
* 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?
2015-12-10 14:36:26 +00:00
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
If you are interested in fixing issues and contributing directly to the code base,
2016-04-22 19:54:32 +00:00
please see the document [How to Contribute](https://github.com/Microsoft/vscode/wiki/How-to-Contribute).