From c6b7ec9dbcb3609d25bfe2f33f9328a3df99221f Mon Sep 17 00:00:00 2001 From: "Christian \"Krissy\" Silvermoon" <30162808+ChristianSilvermoon@users.noreply.github.com> Date: Tue, 15 Nov 2022 08:04:11 -0700 Subject: [PATCH] Add GitHub Bug Report and Feature Request Templates Having a template can encourage users to provide helpful information and provide better organization to the structure of issue reports It can also help encourage users to include one issue per report --- .github/ISSUE_TEMPLATE/bug-report.yml | 45 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.yml | 19 +++++++++ 2 files changed, 64 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..2c653e3b2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,45 @@ +name: Bug Report +description: Report a Bug or Problem +title: "[Bug]: " +labels: [ "bug" ] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to report your issue! + * Please try to report a *single* issue per report to help make them easier to track. + * Please double check that someone else hasn't already reported the same issue. + - type: input + id: gameversion + validations: + required: true + attributes: + label: Game Version + description: What is your **version number**? + placeholder: "Example: v0.8.7" + - type: input + id: platform + validations: + required: true + attributes: + label: Platform + description: What is your **Operating System**? + placeholder: "Example: Windows 11 64-bit, Ubuntu 12.10, MacOS 13.0, etc" + - type: textarea + id: problem + validations: + required: true + attributes: + label: What happened? + description: Describe the thing that lead you here. Was something not working as expected? What were you doing when it happened? + placeholder: | + Example: + I was walking around in the forest at night, and grave yard fog covered my screen when day came. I was in a grave yard before it turned to night last, and was in a battle when day came. + - type: textarea + id: expectation + attributes: + label: "What should've happened? (Optional)" + description: "Give a brief description about what you believe should've happened in this situation." + placeholder: | + Example: + The grave yard fog is only supposed to appear in the grave yard biome, does not appear in the forest normally. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 000000000..ab132c0ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,19 @@ +name: Feature Request +description: Request a Feature to be added to the game +title: "[Feature Request]: " +labels: [ "enhancement" ] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to Request a feature! + * Please try to request a *single* feature per issue to help make them easier to track. + * Please double check that someone else hasn't already requested the same thing. + * Please double check the [Future Plans](https://github.com/SheerSt/pokemon-wilds/wiki/Future-Plans-(WIP)) to ensure your idea isn't already planned. + - type: textarea + id: feature + validations: + required: true + attributes: + label: What would you like to request? + description: "Give a description of the feature you'd like to see in the game and why."