From 0a17c25d31f2a28809f33be7cb346d986f8e89b0 Mon Sep 17 00:00:00 2001 From: Kris The Goat Date: Tue, 12 Apr 2022 20:52:36 -0500 Subject: [PATCH 1/5] Added Github config.yml --- .github/ISSUE_TEMPLATE/config.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..f6a6f2eb2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: UnderMiners Discord + url: https://discord.gg/UMwccfs2Hb + about: For UndertaleModTool questions, discussion, analysis and feedback \ No newline at end of file From 17a3b9591b538f14a0f6e0d2ecdbfb91010c7713 Mon Sep 17 00:00:00 2001 From: Kris The Goat Date: Tue, 12 Apr 2022 22:01:57 -0500 Subject: [PATCH 2/5] Added Yaml based issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 35 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 23 ++++++++++++++ 2 files changed, 58 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..c840afd93 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,35 @@ +name: Bug Report +description: Something not behaving the way it should? Let us know! +title: "Bug: " +labels: [bug, needs triage] +assignees: + - Grossley +body: +- type: textarea + attributes: + label: Describe the bug + description: A clear description of what the bug is. Please consider adding pictures and/or videos, as they really help! + placeholder: | + When I do X then Y happens. + validations: + required: true +- type: textarea + attributes: + label: To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Open X ... + 2. Do Y ... + 3. See error + validations: + required: true +- type: textarea + attributes: + label: Setup Details + description: A clear and concise description of your tools and enviroment used. + placeholder: | + 1. UndertaleModTool version: What UndertaleModTool version you used? If compiled from source, please specify the commit number. + 2. Operating system: Specify a version e.g. Windows 10, Mac OS X Catalina, Ubuntu, ect... + 3. GameMaker Game: What GameMaker game was used? Link to it! + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..7158d3d6a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,23 @@ +name: Suggest a Feature +description: Have an idea for something completely new or for improving something that UndertaleModTool has or could benefit from doing or having? Let us know! +title: "Feature: <Title>" +labels: [enhancement, needs triage] +assignees: + - Grossley +body: +- type: dropdown + attributes: + label: Which component should be improved? + options: [UI/UX, Decompiler, Compiler, CLI, Lib, Other] + validations: + required: true +- type: textarea + attributes: + label: Describe your feature suggestion in more detail + description: Feel free to add pictures or video directly to this description! + placeholder: | + Give a clear explanation of what you want us to add. + Please don't give vague suggestions like "Make button look better" or "Add a new panel". + How exactly does it work? What are the inputs? What is the expected outcome? + validations: + required: true \ No newline at end of file From 1c5fd56f7418ea9dd79bd9fd933b617494c38ce3 Mon Sep 17 00:00:00 2001 From: Kris The Goat <nikodash2020@hotmail.com> Date: Tue, 12 Apr 2022 22:14:14 -0500 Subject: [PATCH 3/5] Added Pullrequest Markdown Templates No forms version for PR Templates :skull: Co-Authored-By: Miepee <38186597+Miepee@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE/docs_pr.md | 14 ++++++++++++++ .../feature_or_bugfix_pr.md | 17 +++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/docs_pr.md create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md diff --git a/.github/PULL_REQUEST_TEMPLATE/docs_pr.md b/.github/PULL_REQUEST_TEMPLATE/docs_pr.md new file mode 100644 index 000000000..dfb793559 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/docs_pr.md @@ -0,0 +1,14 @@ +--- +name: Documentation improvement +about: Changes to things other than code +title: +labels: documentation, needs triage +assignees: @Grossley + +--- + +## Description +<!-- A clear, in-depth description of what the changes are. Reference existing issues and add screenshots if necessary! --> + +### Notes +<!-- Any notes or closing words --> diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md b/.github/PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md new file mode 100644 index 000000000..3dbe21b04 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md @@ -0,0 +1,17 @@ +--- +name: New Feature or Bug fix +about: Implementation of a new feature or fixes an existing one +title: +labels: enhancement, needs triage +assignees: @Grossley + +--- + +## Description +<!-- A clear, in-depth description of what the changes are. Reference existing issues and add screenshots if necessary! --> + +### Caveats +<!-- Any caveats, side effects or regressions of this PR --> + +### Notes +<!-- Any notes or closing words --> \ No newline at end of file From bc4993f42ff5594546c07923eb44e3eba71acdda Mon Sep 17 00:00:00 2001 From: Kris The Goat <nikodash2020@hotmail.com> Date: Wed, 13 Apr 2022 12:17:13 -0500 Subject: [PATCH 4/5] Remove PR Templates --- ...re_or_bugfix_pr.md => PULL_REQUEST_TEMPLATE.md} | 9 --------- .github/PULL_REQUEST_TEMPLATE/docs_pr.md | 14 -------------- 2 files changed, 23 deletions(-) rename .github/{PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md => PULL_REQUEST_TEMPLATE.md} (61%) delete mode 100644 .github/PULL_REQUEST_TEMPLATE/docs_pr.md diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md b/.github/PULL_REQUEST_TEMPLATE.md similarity index 61% rename from .github/PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md rename to .github/PULL_REQUEST_TEMPLATE.md index 3dbe21b04..7b29d6121 100644 --- a/.github/PULL_REQUEST_TEMPLATE/feature_or_bugfix_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,3 @@ ---- -name: New Feature or Bug fix -about: Implementation of a new feature or fixes an existing one -title: -labels: enhancement, needs triage -assignees: @Grossley - ---- - ## Description <!-- A clear, in-depth description of what the changes are. Reference existing issues and add screenshots if necessary! --> diff --git a/.github/PULL_REQUEST_TEMPLATE/docs_pr.md b/.github/PULL_REQUEST_TEMPLATE/docs_pr.md deleted file mode 100644 index dfb793559..000000000 --- a/.github/PULL_REQUEST_TEMPLATE/docs_pr.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Documentation improvement -about: Changes to things other than code -title: -labels: documentation, needs triage -assignees: @Grossley - ---- - -## Description -<!-- A clear, in-depth description of what the changes are. Reference existing issues and add screenshots if necessary! --> - -### Notes -<!-- Any notes or closing words --> From 48875cc06006ac34c6d18f592037239b342463d9 Mon Sep 17 00:00:00 2001 From: Kris The Goat <nikodash2020@hotmail.com> Date: Wed, 13 Apr 2022 12:18:04 -0500 Subject: [PATCH 5/5] Grammar fixes, fixed label issues, remove grossley Co-Authored-By: Miepee <38186597+Miepee@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 12 +++++------- .github/ISSUE_TEMPLATE/feature_request.yml | 8 +++----- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c840afd93..f2469634d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,21 +1,19 @@ name: Bug Report description: Something not behaving the way it should? Let us know! title: "Bug: <Title>" -labels: [bug, needs triage] -assignees: - - Grossley +labels: ["bug"] body: - type: textarea attributes: label: Describe the bug description: A clear description of what the bug is. Please consider adding pictures and/or videos, as they really help! placeholder: | - When I do X then Y happens. + When doing X, UndertaleModTool crashes. validations: required: true - type: textarea attributes: - label: To Reproduce + label: Reproducing steps description: Steps to reproduce the behavior. placeholder: | 1. Open X ... @@ -28,8 +26,8 @@ body: label: Setup Details description: A clear and concise description of your tools and enviroment used. placeholder: | - 1. UndertaleModTool version: What UndertaleModTool version you used? If compiled from source, please specify the commit number. - 2. Operating system: Specify a version e.g. Windows 10, Mac OS X Catalina, Ubuntu, ect... + 1. UndertaleModTool version: What UndertaleModTool version did you use? If compiled from source, please specify the commit number. + 2. Operating system: Specify the OS and version e.g. Windows 10, Mac OS X Catalina, Ubuntu 20.04, etc. 3. GameMaker Game: What GameMaker game was used? Link to it! validations: 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 7158d3d6a..63be30820 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,9 +1,7 @@ name: Suggest a Feature -description: Have an idea for something completely new or for improving something that UndertaleModTool has or could benefit from doing or having? Let us know! +description: Have an idea for something completely new that UndertaleModTool could benefit from having? Or for improving something that already exists? Let us know! title: "Feature: <Title>" -labels: [enhancement, needs triage] -assignees: - - Grossley +labels: ["enhancement"] body: - type: dropdown attributes: @@ -14,7 +12,7 @@ body: - type: textarea attributes: label: Describe your feature suggestion in more detail - description: Feel free to add pictures or video directly to this description! + description: A clear description of your feature suggestion. Feel free to add pictures or videos directly to this description! placeholder: | Give a clear explanation of what you want us to add. Please don't give vague suggestions like "Make button look better" or "Add a new panel".