From 755fa4d5f394b991bcf6433040539441d5064464 Mon Sep 17 00:00:00 2001 From: Nicholas Hastings Date: Sun, 19 Jan 2025 11:09:16 -0500 Subject: [PATCH] Update issue template to use new workflow model (#2248) * Update issue template to use new workflow model * Nuke old issue template * Convert bug report template to form * Add issue template config with support links --- .github/ISSUE_TEMPLATE.md | 26 ----- .github/ISSUE_TEMPLATE/bug_report.yml | 116 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 ++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++ 4 files changed, 147 insertions(+), 26 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index e3ba249954..0000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,26 +0,0 @@ -# Help us help you - - [ ] I have checked that my issue [doesn't exist yet](https://github.com/alliedmodders/sourcemod/issues). - - [ ] I have tried my absolute best to reduce the problem-space and have provided the absolute smallest test-case possible. - - [ ] I can always reproduce the issue with the provided description below. - -# Environment - * Operating System version: - * Game/AppID (with version if applicable): - * Current SourceMod version: - * Current SourceMod snapshot: - * Current Metamod: Source snapshot: - - [ ] I have updated SourceMod to the [latest version](https://www.sourcemod.net/downloads.php) and it still happens. - - [ ] I have updated SourceMod to the [latest snapshot](https://www.sourcemod.net/downloads.php?branch=dev) and it still happens. - - [ ] I have updated SourceMM to the [latest snapshot](https://sourcemm.net/downloads.php?branch=dev) and it still happens. - -# Description - - -# Problematic Code (or Steps to Reproduce) - ``` - // TODO(you): code here to reproduce the problem - ``` - -# Logs -* Please attach in separate files: game output, library logs, kernel logs, and any other supporting information. -* In case of a crash, please attach minidump or dump analyze output. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000000..20e60f184c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,116 @@ +name: Bug Report +description: Create a report to help us improve +title: "[Bug]: " +labels: ["Bug"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! Please make sure you provide all the requested information to help us address the issue efficiently. + + - type: checkboxes + id: prerequisites + attributes: + label: Prerequisites + description: Please confirm these before submitting your issue + options: + - label: I have checked that my issue doesn't exist yet in the [issue tracker](https://github.com/alliedmodders/sourcemod/issues) + required: true + - label: I have provided the smallest possible test-case to reproduce the issue + required: false + - label: I can consistently reproduce this issue with the provided description + required: false + + - type: input + id: os-version + attributes: + label: Operating System Version + description: What operating system and version are you using? + placeholder: "e.g., Windows 10 21H2, Ubuntu 22.04" + validations: + required: true + + - type: input + id: game-version + attributes: + label: Game/AppID and Version + description: Which game and version are you using? + placeholder: "e.g., CS:GO (730) version 1.38.2.5" + validations: + required: true + + - type: input + id: sourcemod-version + attributes: + label: SourceMod Version + description: On which version of SourceMod did you first observe this? + placeholder: "e.g., 1.11.0.6936" + validations: + required: true + + - type: input + id: metamod-version + attributes: + label: Metamod:Source Version + description: On which version of Metamod:Source did you first observe this? + placeholder: "e.g., 1.11.0-git1145" + + - type: checkboxes + id: version-checks + attributes: + label: Version Verification + description: Please confirm you've tested with the latest versions + options: + - label: I have updated SourceMod to the [latest version](https://www.sourcemod.net/downloads.php) and the issue persists + - label: I have updated SourceMod to the [latest snapshot](https://www.sourcemod.net/downloads.php?branch=dev) and the issue persists + - label: I have updated Metamod:Source to the [latest snapshot](https://sourcemm.net/downloads.php?branch=dev) and the issue persists + + - type: input + id: sourcemod-version-latest + attributes: + label: Updated SourceMod Version + description: If you updated SourceMod to the latest version to confirm the issue persisted, which version was that? + placeholder: "e.g., 1.11.0.6936" + + - type: input + id: metamod-version-latest + attributes: + label: Updated Metamod:Source Version + description: If you updated Metamod:Source to the latest version to confirm the issue persisted, which version was that? + placeholder: "e.g., 1.11.0-git1145" + + - type: textarea + id: description + attributes: + label: Description + description: Please provide a clear and concise description of the bug + placeholder: What happened? What did you expect to happen? + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Steps to Reproduce + description: Please provide the code or steps needed to reproduce the issue + placeholder: | + 1. First step... + 2. Second step... + 3. ... + + ```sourcepawn + // Add your code here if applicable + ``` + + - type: textarea + id: logs + attributes: + label: Relevant Log Output + description: | + Please provide any relevant log output. This will be automatically formatted into code, so no need for backticks. + Include: + - Game output + - Library logs + - Kernel logs + - Minidump or dump analyze output (in case of crashes) + render: shell diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..e5a31003e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: AlliedModders Discord + url: https://discord.gg/HUc67zN + about: General support or assistance + - name: AlliedModders Forums + url: https://forums.alliedmods.net + about: General support or assistance diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..b0d0572f34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: Feature Request +assignees: '' + +--- + +## Help us help you + - [ ] I have checked that my issue [doesn't exist yet](https://github.com/alliedmodders/sourcemod/issues). + +## 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 [...] + +## Describe the solution you'd like +A clear and concise description of what you want to happen. + +## Describe alternatives you've considered +A clear and concise description of any alternative solutions or features you've considered. + +## Additional context +Add any other context or screenshots about the feature request here.