From 1d3c2de650383b37adc40a6ab3924ba491eec7d1 Mon Sep 17 00:00:00 2001 From: LArrowHead Date: Thu, 2 Aug 2018 13:22:34 -0400 Subject: [PATCH 1/3] Update GFM cheet sheat info, fixed spelling --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 72f9c34..21d69cd 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ If it has not been reported, create a new issue with at least the following info - steps for reproducing the issue; and - your system information.\* -Please place logs either in a code block (press `M` in your browser for a GFM cheat sheet) or a [gist](https://gist.github.com) if they are lengthy. Information on log locations what what do with them, can be found on [wiki](https://github.com/ValveSoftware/SteamOS/wiki/Reviewing-log-information). +Please place logs either in a code block ([go here](https://guides.github.com/features/mastering-markdown/) for a GFM cheat sheet) or a [gist](https://gist.github.com) if they are lengthy. Information on log locations and what to do with them can be found on the [wiki](https://github.com/ValveSoftware/SteamOS/wiki/Reviewing-log-information). Conduct ------- From 3866cd743270874cd9a2efe7b94baa6b58314ef0 Mon Sep 17 00:00:00 2001 From: LArrowHead Date: Thu, 2 Aug 2018 13:27:16 -0400 Subject: [PATCH 2/3] Update System Information, Report Issues Info --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21d69cd..712c1b4 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,23 @@ If it has not been reported, create a new issue with at least the following info - a short, descriptive title; - a detailed description of the issue, including any output from the command line; - steps for reproducing the issue; and -- your system information.\* +- your [system information](#system-information). + +Please place logs either in a code block ([go here](https://guides.github.com/features/mastering-markdown/) for a GFM cheat sheet) or a [gist](https://gist.github.com) if they are lengthy. Information on log locations and what to do with them can be found on the [wiki](https://github.com/ValveSoftware/SteamOS/wiki/Reviewing-log-information). + +When possible, please include a differential between a working configuration and the reported issue. + +If a crash is involved, please include any CrashIDs or minidumps related to the issue in an archive. Archives can be drag and dropped into the text box of github. + +For tracking purposes, there should be one issue per issue report. + +### System information + +System information can be gathered from within steam (`Help -> System Information`). + +Once your information appears: right-click within the dialog, choose `Select All`, right-click again, and then choose `Copy`. +Paste this information into a [gist](https://gist.github.com/) and include a link to it from your bug report. -Please place logs either in a code block ([go here](https://guides.github.com/features/mastering-markdown/) for a GFM cheat sheet) or a [gist](https://gist.github.com) if they are lengthy. Information on log locations and what to do with them can be found on the [wiki](https://github.com/ValveSoftware/SteamOS/wiki/Reviewing-log-information). Conduct ------- From 3874961a5a5c0f256d3e7ec61740edf396da662b Mon Sep 17 00:00:00 2001 From: LArrowHead Date: Thu, 2 Aug 2018 13:29:31 -0400 Subject: [PATCH 3/3] Capitalization --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 712c1b4..95e0cf7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -SteamOS community tracker +SteamOS Community Tracker ========================= This issue tracker is meant for community support and requests for improvements.