From 922cd225e5014f1a946cf9c1a6afab0ee7435fa4 Mon Sep 17 00:00:00 2001 From: Cooldude2606 Date: Wed, 29 May 2019 21:07:21 +0100 Subject: [PATCH] Better issuse formats --- .github/ISSUE_TEMPLATE/Bug_report.md | 20 +++++----- .github/ISSUE_TEMPLATE/Desync_report.md | 24 ++++++++++++ .github/ISSUE_TEMPLATE/Error_report.md | 46 ++++++++++++----------- .github/ISSUE_TEMPLATE/Feature_request.md | 17 +++++---- 4 files changed, 68 insertions(+), 39 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/Desync_report.md diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md index 8d1d7915..885ebd8e 100644 --- a/.github/ISSUE_TEMPLATE/Bug_report.md +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -1,18 +1,24 @@ --- name: Bug report -about: Create a report to help us improve +about: Report a bug which does not crash the game, any bug from the latest major scenario version --- -**Describe the bug** +**Factorio version** +Version number: X.Y.Z + +**Scenario version** +Version number: X.Y.Z + +**Bug description** A clear and concise description of what the bug is. -**To Reproduce** +**Reproduction method** Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' -4. See error +4. See error in log **Expected behavior** A clear and concise description of what you expected to happen. @@ -20,9 +26,5 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Other information (please complete the following information):** - - OS: [e.g. iOS, Windows, Linux] - - Factorio Version: [e.g. 0.16.30] - **Additional context** -Add any other context about the problem here. +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Desync_report.md b/.github/ISSUE_TEMPLATE/Desync_report.md new file mode 100644 index 00000000..5c7e81f9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Desync_report.md @@ -0,0 +1,24 @@ +--- +name: Desync report +about: Report a desync, latest version of scenario only including patches + +--- + +**Factorio version** +Version number: X.Y.Z + +**Scenario version** +Version number: X.Y.Z + +**Desync description** +A clear and concise description of what you believe causes the desync. + +**Reproduction method** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error in log + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Error_report.md b/.github/ISSUE_TEMPLATE/Error_report.md index 85f5a32f..d9ca9b28 100644 --- a/.github/ISSUE_TEMPLATE/Error_report.md +++ b/.github/ISSUE_TEMPLATE/Error_report.md @@ -1,33 +1,35 @@ --- -name: Error/Desync Report -about: Create a report on a bug which gives an error or desync +name: Error report +about: Report a bug which cases the game to crash, any bug from the latest major scenario version --- -**Error Message** -Error: insert error message +**Factorio version** +Version number: X.Y.Z -**Known Causes** -Know causes that will result in error: - - Cause 1 - - Cause 2 +**Scenario version** +Version number: X.Y.Z -**To Reproduce (please give for each cause outlined above)** +**Error message** +``` +error message and stacktrace back +``` + +**Error description** +A clear and concise description of what you believe causes the crash. + +**Reproduction method** Steps to reproduce the behavior: - - Cause 1 - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error - - Cause 2 - 1. Go to '...' - 2. Click on '....' - 3. Scroll down to '....' - 4. See error +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error in log -**Other information (please complete the following information):** - - OS: [e.g. iOS, Windows, Linux] - - Factorio Version: [e.g. 0.16.30] +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. **Additional context** Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md index 066b2d92..6bdc2252 100644 --- a/.github/ISSUE_TEMPLATE/Feature_request.md +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -1,17 +1,18 @@ --- name: Feature request -about: Suggest an idea for this project +about: Suggest a new idea to be worked on --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +**Feature overview** +Name: name-here +TL;DR: a few words about what the feature is -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +**Details** +A detailed description of what the new feature is. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +**Possible methods** +Any ideas you have had about how to implement the feature or any problems that may arise. **Additional context** -Add any other context or screenshots about the feature request here. +Add any other context or screenshots about the feature request here. \ No newline at end of file