From f11ed5c9bc50ee1428caf3bb91adf747881cce8c Mon Sep 17 00:00:00 2001 From: Erik Darling <2136037+erikdarlingdata@users.noreply.github.com> Date: Thu, 19 Feb 2026 12:20:25 -0500 Subject: [PATCH] Convert issue templates from markdown to structured forms MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Required fields prevent incomplete bug reports. Users must provide version, OS, SQL Server version, and repro steps before submitting. Blank issues disabled — all issues go through a template. Co-Authored-By: Claude Opus 4.6 --- .github/ISSUE_TEMPLATE/bug_report.md | 51 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 111 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 41 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 62 ++++++++++++ .github/ISSUE_TEMPLATE/question.md | 38 ------- .github/ISSUE_TEMPLATE/question.yml | 59 +++++++++++ 7 files changed, 233 insertions(+), 131 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index aecbfeec..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -name: Bug Report -about: Report a problem with Performance Monitor -title: '[BUG] ' -labels: bug -assignees: '' ---- - -## Environment - -- **SQL Server Version**: (e.g., SQL Server 2019 CU25) -- **Windows Version**: (e.g., Windows Server 2022) -- **Component**: (Dashboard / Lite / Installer / SQL Scripts) -- **Performance Monitor Version**: (e.g., 1.0.0) - -## Describe the Bug - -A clear description of what the bug is. - -## Steps to Reproduce - -1. -2. -3. - -## Expected Behavior - -What you expected to happen. - -## Actual Behavior - -What actually happened. - -## Error Messages - -``` -Paste any error messages here -``` - -## Screenshots - -If applicable, add screenshots to help explain the problem. - -## Additional Context - -- Did this work before? If so, what changed? -- Are there any relevant SQL Server configuration settings? -- Is SQL Server Agent running? (Full Edition only) -- Are you monitoring Azure SQL DB, Azure MI, or AWS RDS? - -**IMPORTANT: If you're going to contribute code, please read the [contributing guide](https://github.com/erikdarlingdata/PerformanceMonitor/blob/main/CONTRIBUTING.md) first.** diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..2dd0a89b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,111 @@ +name: Bug Report +description: Report a problem with Performance Monitor +title: "[BUG] " +labels: ["bug"] + +body: + - type: dropdown + id: component + attributes: + label: Component + description: Which part of Performance Monitor is affected? + options: + - Full Dashboard + - Lite + - Installer (CLI) + - Installer (GUI) + - SQL collection scripts + validations: + required: true + + - type: input + id: version + attributes: + label: Performance Monitor Version + description: Check the About dialog or the release you downloaded. + placeholder: "e.g., 1.2.0" + validations: + required: true + + - type: input + id: sql-version + attributes: + label: SQL Server Version + description: "Run SELECT @@VERSION on the target server." + placeholder: "e.g., SQL Server 2019 CU25" + validations: + required: true + + - type: input + id: windows-version + attributes: + label: Windows Version + description: The OS where the Dashboard or Lite app is running. + placeholder: "e.g., Windows 11 23H2, Windows Server 2022" + validations: + required: true + + - type: textarea + id: description + attributes: + label: Describe the Bug + description: A clear description of what the bug is. + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: How can we reproduce this? + placeholder: | + 1. Open the Dashboard + 2. Click on... + 3. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What you expected to happen. + validations: + required: true + + - type: textarea + id: actual + attributes: + label: Actual Behavior + description: What actually happened. + validations: + required: true + + - type: textarea + id: errors + attributes: + label: Error Messages / Log Output + description: Paste any error messages or relevant log entries. Dashboard logs are in %LOCALAPPDATA%\PerformanceMonitor\Logs\. + render: text + validations: + required: false + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain the problem. + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional Context + description: | + Anything else that might help: + - Did this work before? If so, what changed? + - Is SQL Server Agent running? (Full Edition only) + - Are you monitoring Azure SQL DB, Azure MI, or AWS RDS? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f4437a2f..1e486216 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,4 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: - name: Questions & Discussion url: https://github.com/erikdarlingdata/PerformanceMonitor/discussions diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index cc3aa157..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: Feature Request -about: Suggest a new feature or enhancement -title: '[FEATURE] ' -labels: enhancement -assignees: '' ---- - -## Problem Statement - -Describe the problem you're trying to solve or the limitation you're facing. - -## Proposed Solution - -Describe your proposed feature or enhancement. - -## Use Case - -How would you use this feature? Provide a specific example. - -## Alternatives Considered - -Have you considered any alternative solutions or workarounds? - -## Additional Context - -- Is this related to a specific SQL Server version? -- Would this require schema changes? -- How frequently would you use this feature? - -## Scope - -Please indicate which component(s) this affects: - -- [ ] Full Dashboard -- [ ] Lite -- [ ] SQL collection scripts -- [ ] Installer -- [ ] Documentation - -**IMPORTANT: If you're going to contribute code, please read the [contributing guide](https://github.com/erikdarlingdata/PerformanceMonitor/blob/main/CONTRIBUTING.md) first.** diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..10c4de58 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,62 @@ +name: Feature Request +description: Suggest a new feature or enhancement +title: "[FEATURE] " +labels: ["enhancement"] + +body: + - type: checkboxes + id: component + attributes: + label: Which component(s) does this affect? + options: + - label: Full Dashboard + - label: Lite + - label: SQL collection scripts + - label: Installer + - label: Documentation + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem Statement + description: Describe the problem you're trying to solve or the limitation you're facing. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe your proposed feature or enhancement. + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: How would you use this feature? Provide a specific example. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Have you considered any alternative solutions or workarounds? + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional Context + description: | + Anything else: + - Is this related to a specific SQL Server version? + - Would this require schema changes? + - How frequently would you use this feature? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index bbe5554a..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Question -about: I have a question about Performance Monitor -title: '[QUESTION] ' -labels: question -assignees: '' ---- - -## Which component is your question about? - -- [ ] Full Dashboard -- [ ] Lite -- [ ] SQL collection scripts -- [ ] Installer -- [ ] General / setup - -## Version - -All components have a version number. Make sure you're on a recent version. - -**Performance Monitor Version**: (e.g., 1.0.0) - -## Is your question about how it works, or the results? - -Questions about *how the tool works* can be answered here. - -If you have questions about the results, performance tuning, or SQL Server in general, you'll want to check: -* https://www.erikdarling.com/ -* https://dba.stackexchange.com/ - -## What's your question? - -A clear description of what you'd like to know. - -## Additional Context - -- SQL Server version and edition -- Are you using Azure SQL DB, Azure MI, or AWS RDS? diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..dec7b93d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,59 @@ +name: Question +description: I have a question about Performance Monitor +title: "[QUESTION] " +labels: ["question"] + +body: + - type: dropdown + id: component + attributes: + label: Which component is your question about? + options: + - Full Dashboard + - Lite + - SQL collection scripts + - Installer + - General / setup + validations: + required: true + + - type: input + id: version + attributes: + label: Performance Monitor Version + description: Check the About dialog or the release you downloaded. + placeholder: "e.g., 1.2.0" + validations: + required: true + + - type: dropdown + id: question-type + attributes: + label: Is your question about how it works, or the results? + description: Questions about results or SQL Server tuning are better suited for https://www.erikdarling.com/ or https://dba.stackexchange.com/ + options: + - How the tool works + - Setup / installation + - Results / data interpretation + - Contributing / development + validations: + required: true + + - type: textarea + id: question + attributes: + label: What's your question? + description: A clear description of what you'd like to know. + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional Context + description: | + Anything that might help: + - SQL Server version and edition + - Are you using Azure SQL DB, Azure MI, or AWS RDS? + validations: + required: false