From e3c15817e472a470fa82c201970a6a09f6720813 Mon Sep 17 00:00:00 2001 From: Hielke Morsink Date: Mon, 7 Jun 2021 19:14:11 +0200 Subject: [PATCH 1/6] Use GitHub issue forms --- .github/ISSUE_TEMPLATE/bug_report.md | 35 -------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 63 ++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 3 files changed, 64 insertions(+), 35 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index e0406d2257..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -name: Bug Report -about: Describe an issue you encountered when playing OpenRCT2 -title: '' -labels: '' -assignees: '' - ---- - - -**OS:** [e.g. Windows 10] -**Version:** [e.g. 0.3.4.1] -**Commit/Build:** [e.g. 426e106] - - - - - -- [ ] Reproducible in RCT2 (vanilla)? -- [ ] Specific to multiplayer? - -**Steps to reproduce:** -1. -2. - -**Dump file** - - -**Screenshots / Video:** - - -**Save game:** - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000000..1d69d594c9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,63 @@ +name: Bug report +title: "[Bug] " +description: Report an issue you encountered when playing OpenRCT2 +labels: +- bug + +body: +- type: markdown + attributes: + value: Before filing this bug, [please check if it hasn't already been reported](https://github.com/OpenRCT2/OpenRCT2/issues?q=is%3Aissue+is%3Aopen+label%3Abug). If it has, please add useful information to the existing issue instead. + +- type: input + attributes: + label: Operating System + placeholder: Windows 10, 64-bit + validations: + required: true + +- type: input + attributes: + label: OpenRCT2 build + placeholder: OpenRCT2, v0.3.4.1 (d76611e on develop) provided by GitHub + description: You can copy the version information from the About window. + validations: + required: true + +- type: textarea + attributes: + label: Describe the issue + description: Please describe the issue you are experiencing here. + validations: + required: true + +- type: dropdown + attributes: + label: Area(s) with issue? + description: What things had an issue? Check all that apply. + multiple: true + options: + - The bug also exists in RCT2 (vanilla) + - This bug is specific to multiplayer + validations: + required: false + +- type: textarea + attributes: + label: Steps to reproduce + description: We highly suggest including a screenshots and a bug report log (System tray->Report bug). + placeholder: Tell us the steps required to trigger your bug. + value: | + 1. + 2. + 3. + validations: + required: true + +- type: textarea + attributes: + label: Attachments + description: Please add any screenshots, dump files and/or videos here that may help us fix the issue. + placeholder: Drag and drop files here to add them + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..3ba13e0cec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false From 6ff1832cc6493b67872b04b8ac664c99988a1490 Mon Sep 17 00:00:00 2001 From: Hielke Morsink Date: Sat, 24 Jul 2021 13:07:32 +0200 Subject: [PATCH 2/6] Add Localisation and Discord links to issue page --- .github/ISSUE_TEMPLATE/config.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0cec..7f833fb616 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,8 @@ blank_issues_enabled: false +contact_links: +- name: Localisation + url: https://github.com/OpenRCT2/Localisation + about: For localisation issues, go to the localisation repository +- name: OpenRCT2 Discord Server + url: https://discord.gg/ZXZd8D8 + about: Join our Discord server From 8ef9e9f6cca9c90f03ad7980bc3a554b7bdc536f Mon Sep 17 00:00:00 2001 From: Hielke Morsink Date: Sat, 24 Jul 2021 12:46:16 +0200 Subject: [PATCH 3/6] Add feature request form --- .github/ISSUE_TEMPLATE/feature_request.yaml | 30 +++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000000..f09bfa50be --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,30 @@ +name: Feature request +title: "[Feature] " +description: Request a new feature to be added to OpenRCT2. +labels: +- feature + +body: +- type: markdown + attributes: + value: Before filing this request, [please check if it hasn't already been suggested before](https://github.com/OpenRCT2/OpenRCT2/issues?q=is%3Aissue+is%3Aopen+label%3Afeature). If it has, please add to the existing issue instead. + +- type: textarea + attributes: + label: Describe the feature + placeholder: Describe your feature idea here. You can paste or drag & drop attachments here. + validations: + required: true + +- type: dropdown + attributes: + label: Feature type + description: What things had an issue? Check all that apply. + multiple: true + options: + - Quality of life + - Multiplayer + - Plug-ins + - Other + validations: + required: true From 3011cb87c20ce147efaad2c881f11b40ee90e102 Mon Sep 17 00:00:00 2001 From: Hielke Morsink Date: Sat, 24 Jul 2021 13:40:40 +0200 Subject: [PATCH 4/6] Add missing full stops --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 1d69d594c9..66b91afd2b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,6 +1,6 @@ name: Bug report title: "[Bug] " -description: Report an issue you encountered when playing OpenRCT2 +description: Report an issue you encountered when playing OpenRCT2. labels: - bug diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 7f833fb616..04d4701a79 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,7 +2,7 @@ blank_issues_enabled: false contact_links: - name: Localisation url: https://github.com/OpenRCT2/Localisation - about: For localisation issues, go to the localisation repository + about: For localisation issues, go to the localisation repository. - name: OpenRCT2 Discord Server url: https://discord.gg/ZXZd8D8 - about: Join our Discord server + about: Join our Discord server. From 5ed86390293dbb87ca917ec49f1786f8dd30858c Mon Sep 17 00:00:00 2001 From: Hielke Morsink Date: Wed, 28 Jul 2021 00:16:45 +0200 Subject: [PATCH 5/6] Make suggested changes - Remove titles (we have tags, and forces user to enter something) - Remove double space - Update discord invite description --- .github/ISSUE_TEMPLATE/bug_report.yaml | 3 +-- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 3 +-- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 66b91afd2b..455806140e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,5 +1,4 @@ name: Bug report -title: "[Bug] " description: Report an issue you encountered when playing OpenRCT2. labels: - bug @@ -34,7 +33,7 @@ body: - type: dropdown attributes: label: Area(s) with issue? - description: What things had an issue? Check all that apply. + description: What things had an issue? Check all that apply. multiple: true options: - The bug also exists in RCT2 (vanilla) diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 04d4701a79..f09f42a938 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -5,4 +5,4 @@ contact_links: about: For localisation issues, go to the localisation repository. - name: OpenRCT2 Discord Server url: https://discord.gg/ZXZd8D8 - about: Join our Discord server. + about: For help with running or playing the game, join our Discord server. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index f09bfa50be..c428c1d7c2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,5 +1,4 @@ name: Feature request -title: "[Feature] " description: Request a new feature to be added to OpenRCT2. labels: - feature @@ -19,7 +18,7 @@ body: - type: dropdown attributes: label: Feature type - description: What things had an issue? Check all that apply. + description: What things had an issue? Check all that apply. multiple: true options: - Quality of life From 14785155dd59d59064367b60986db960044e04f1 Mon Sep 17 00:00:00 2001 From: Hielke Morsink Date: Sun, 8 Aug 2021 22:11:13 +0200 Subject: [PATCH 6/6] Apply feedback --- .github/ISSUE_TEMPLATE/bug_report.yaml | 6 +++--- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 455806140e..76264b3f41 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -6,7 +6,7 @@ labels: body: - type: markdown attributes: - value: Before filing this bug, [please check if it hasn't already been reported](https://github.com/OpenRCT2/OpenRCT2/issues?q=is%3Aissue+is%3Aopen+label%3Abug). If it has, please add useful information to the existing issue instead. + value: Before filing this bug, [please check if it hasn't already been reported](https://github.com/OpenRCT2/OpenRCT2/issues?q=is%3Aissue+label%3Abug). If it has, please add useful information to the existing issue instead. - type: input attributes: @@ -19,7 +19,7 @@ body: attributes: label: OpenRCT2 build placeholder: OpenRCT2, v0.3.4.1 (d76611e on develop) provided by GitHub - description: You can copy the version information from the About window. + description: You can copy the version information from the About window. Open the "Disk and game options" menu (floppy disk on the top toolbar), choose "About 'OpenRCT2'" and click the copy button next to the version information. validations: required: true @@ -44,7 +44,7 @@ body: - type: textarea attributes: label: Steps to reproduce - description: We highly suggest including a screenshots and a bug report log (System tray->Report bug). + description: We highly suggest including a screenshot and a bug report log (System tray->Report bug). placeholder: Tell us the steps required to trigger your bug. value: | 1. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f09f42a938..d56bb91510 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,6 +1,6 @@ blank_issues_enabled: false contact_links: -- name: Localisation +- name: Translation / Localisation url: https://github.com/OpenRCT2/Localisation about: For localisation issues, go to the localisation repository. - name: OpenRCT2 Discord Server diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index c428c1d7c2..6986b22216 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -6,19 +6,19 @@ labels: body: - type: markdown attributes: - value: Before filing this request, [please check if it hasn't already been suggested before](https://github.com/OpenRCT2/OpenRCT2/issues?q=is%3Aissue+is%3Aopen+label%3Afeature). If it has, please add to the existing issue instead. + value: Before filing this request, [please check if it hasn't already been suggested before](https://github.com/OpenRCT2/OpenRCT2/issues?q=is%3Aissue+label%3Afeature). If it has, please add to the existing issue instead. - type: textarea attributes: label: Describe the feature - placeholder: Describe your feature idea here. You can paste or drag & drop attachments here. + placeholder: Describe your feature idea here. You can paste or drag & drop attachments here to help on illustrating it. validations: required: true - type: dropdown attributes: label: Feature type - description: What things had an issue? Check all that apply. + description: What would this feature improve? Check all that apply. multiple: true options: - Quality of life