Skip to content

Commit 3ddc229

Browse files
authored
Improve README, issue template, and test error output (#1898)
* Improve README and test error output * Adding popular feature requests * Feature Requests gets thumbs up, not issues. * Adding info for issues
1 parent f58217f commit 3ddc229

File tree

4 files changed

+35
-12
lines changed

4 files changed

+35
-12
lines changed

.travis.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,6 @@ script:
3636
# pr-check needs to run before test. test modifies package.json.
3737
- npm run pr-check
3838
- npm run test
39-
40-
after_failure:
41-
- find ~ -name "integrationTests.log" -type f -exec cat {} \;
42-
43-
after_success:
39+
# Dump integrationTest.log output
4440
- find ~ -name "integrationTests.log" -type f -exec cat {} \;
4541

Extension/test/integrationTests/debug.integration.test.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ suite(`Debug Integration Test: `, function() {
2020
let debugSessionTerminated = new Promise(resolve => {
2121
vscode.debug.onDidTerminateDebugSession((e) => resolve());
2222
});
23-
24-
assert.equal(vscode.debug.activeDebugSession.type, "cppdbg");
23+
24+
try {
25+
assert.equal(vscode.debug.activeDebugSession.type, "cppdbg");
26+
} catch (e) {
27+
assert.fail("Debugger failed to launch. Did the extension activate correctly?")
28+
}
2529

2630
await debugSessionTerminated;
2731
});

ISSUE_TEMPLATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
<!--
2+
If this is a performance issue report, please use the VS Code Issue reporter via command palette (f1 -> Help: Report Issue).
3+
Set the field 'This is a' to be 'Performance Issue', the field 'File on' to be 'An Extension', and set 'Extension' to be 'C/C++'.
4+
You may toggle off the data you wish to not send, but with more information we can help.
5+
Fill out the title and steps to reproduce with as much info as you can.
6+
Clicking on 'Preview on GitHub' will open up a webpage for you to submit your issue.
7+
28
If this is a bug report, please give us as much information as possible so we can reproduce your issue.
39
Examples of information that can help us find and fix bugs:
410
* Operating System and version
@@ -9,6 +15,7 @@
915
* A small code sample, zipped up project, or open source repo we can use to verify the bug
1016
* Relevant settings from your settings.json, c_cpp_properties.json, and/or launch.json files
1117
* Any log messages present in the Output window (use "C_Cpp.loggingLevel": "Information" in settings.json)
18+
* Debugger logs (use "logging": { "engineLogging": true } in your launch.json)
1219
1320
Please also take a look at our documentation, as we may already have answers for your questions:
1421
* https://github.com/Microsoft/vscode-cpptools/tree/master/Documentation

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
11
# vscode-cpptools
22

3-
This is the official repository for filing issues against and getting support for the [Microsoft C/C++ extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools).
3+
This is the official repository for the [Microsoft C/C++ extension for VS Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools).
44

5-
### Microsoft Open Source Code of Conduct
5+
The `vscode-cpptools` repository is where we do development and there are many ways you can support the extension, for example:
66

7-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [email protected] with any additional questions or comments.
7+
* [Report issues or request features](https://github.com/Microsoft/vscode-cpptools/issues)
8+
- If someone has filed a similar issue, please provide any additional information that can help us resolve it on the issue
9+
- If someone has filed a similar feature request, please leave a thumbs up reaction on the issue
10+
- [List of popular feature requests](https://github.com/Microsoft/vscode-cpptools/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A%22Feature+Request%22)
11+
* [Contribute to the extension](Extension)
12+
13+
## Getting Started
14+
15+
You can learn how to use the extension at [VS Code for C/C++](https://code.visualstudio.com/docs/languages/cpp).
16+
17+
If you clone this repository, you can also try out our [Code Samples](Code%20Samples).
818

9-
### Documentation
19+
If you have any questions, check out our our [**Documentation**](Documentation) folder. If you do not find your answer there, feel free to ask it in our [issues page](https://github.com/Microsoft/vscode-cpptools/issues).
1020

11-
The documentation has been moved to the [**Documentation**](Documentation) folder. If you would like to contribute, please create a Markdown file and submit a pull request.
21+
### Contribution
22+
23+
Contributions are always welcome. Please see our [contributing guide](CONTRIBUTING.md) for more details.
24+
25+
### Microsoft Open Source Code of Conduct
26+
27+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [email protected] with any additional questions or comments.
1228

1329
### Data/Telemetry
1430

0 commit comments

Comments
 (0)