From f8255d9e8006f2192dd8a8d29236e2afff90af07 Mon Sep 17 00:00:00 2001 From: Andreas Maerten <24669514+Yimura@users.noreply.github.com> Date: Tue, 18 Jul 2023 15:56:05 +0200 Subject: [PATCH] feat(IssueTemplates): Update issue templates and added 2 more (#1759) --- .github/ISSUE_TEMPLATE/bug_report.yml | 17 ++++-- .github/ISSUE_TEMPLATE/build_issue.yml | 53 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .../ISSUE_TEMPLATE/improvement_request.yml | 28 ++++++++++ 4 files changed, 96 insertions(+), 4 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/build_issue.yml create mode 100644 .github/ISSUE_TEMPLATE/improvement_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8096a0d3..157f1a73 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -28,8 +28,12 @@ body: required: true - type: textarea attributes: - label: Screenshots and/or Logs - description: "Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in." + label: Logs and/or screenshots + description: | + For a bug report to be valid, please include the logs for YimMenu. + They can be found under `%appdata%/YimMenu/cout.log`, even if you think the log file is useless we'd still like for you to include it here. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. value: | ``` @@ -57,7 +61,14 @@ body: - type: checkboxes attributes: label: Build - description: This last section is to make sure the bug exists on this version of YimMenu. If you have your own version of YimMenu and haven't confirmed the bug exists on the current version of YimMenu this makes the bug report invalid. + description: We want to confirm that this issue exists on the latest version of YimMenu, not a fork or your own version of YimMenu. options: - label: I've confirmed the issue exists on the latest version of YimMenu required: true +- type: checkboxes + attributes: + label: Coload + description: Make sure you test YimMenu without co-loading (Menyoo, Stand, ...) first and see if the issue exists, if it doesn't verify if you think the issue lies with us or with the product you're co-loading with. + options: + - label: I've tested this without co-loading anything. + required: true diff --git a/.github/ISSUE_TEMPLATE/build_issue.yml b/.github/ISSUE_TEMPLATE/build_issue.yml new file mode 100644 index 00000000..b3bb2c6d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/build_issue.yml @@ -0,0 +1,53 @@ +name: Build issue +description: Report a problem with building YimMenu +title: "[Build]: " +labels: build +body: +- type: textarea + attributes: + label: Describe the build issues + description: A clear and concise description of what the issue is. + validations: + required: true +- type: textarea + attributes: + label: Screenshots and/or Logs + description: "Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in." + value: | + ``` + + ``` + validations: + required: false +- type: dropdown + attributes: + label: IDE/Compiler + description: Which IDE do you use to build YimMenu? + multiple: false + options: + - Visual Studio 2022 + - Visual Studio Code + - Command Line + - Other (please mention in "Additional context") + validations: + required: true +- type: textarea + attributes: + label: Additional context + description: Add any other context about the problem here. + validations: + required: false +- type: checkboxes + attributes: + label: Setup Guide + description: You confirm that you followed the setup guide as described [here](https://github.com/YimMenu/YimMenu/wiki/Setup-your-PC-for-YimMenu-Development). + options: + - label: I confirm that I followed the setup guide correctly. + required: true +- type: checkboxes + attributes: + label: YimMenu Source Code + description: You confirm that you haven't modified YimMenu and are building the latest version of the source code. + options: + - label: I've confirmed this is an issue with building unmodified YimMenu. + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index a2683c0d..5f1559a7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,7 +1,7 @@ name: Feature request description: Suggest an idea for this project title: "[Request]: " -labels: enhancement +labels: request body: - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/improvement_request.yml b/.github/ISSUE_TEMPLATE/improvement_request.yml new file mode 100644 index 00000000..f344a393 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement_request.yml @@ -0,0 +1,28 @@ +name: Improvement request +description: Improve an existing feature in YimMenu. +title: "[Improvement]: " +labels: improvement +body: +- type: textarea + attributes: + label: Which feature + description: "Explain to us which feature you want to see improved and what you'd like to be changed about it." + placeholder: "I'd like for the Settings -> ESP feature to be structured differently, currently it's too obscure on how each of the features work together." + validations: + required: false +- type: textarea + attributes: + label: Reason + description: Provide Reasoning + placeholder: "Tell us why you'd want for us to improve this feature in YimMenu." + validations: + required: true +- type: textarea + attributes: + label: Additional context + description: | + Add any other context about the request here. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false