diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 2861c1dd..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve - ---- - -**Version of the script** -Look in the stored procedure, and it'll have a version date & number near the top. Put that in here. If it's not the current version (dated in the last month), then upgrade to the current version and test that before reporting a bug - we fix a lot of stuff in each new build. We'll flat out close bug reports for older builds. - -**What is the current behavior?** - -**If the current behavior is a bug, please provide the steps to reproduce.** - -**What is the expected behavior?** - -**Which versions of SQL Server and which OS are affected by this issue? Did this work in previous versions of our procedures?** - -**IMPORTANT: If you're going to contribute code, please read the contributing guide first.** -https://github.com/erikdarlingdata/DarlingData/blob/main/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..73bf4422 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,102 @@ +name: Bug Report +description: Report a problem with a stored procedure +title: "[BUG] " +labels: ["bug"] + +body: + - type: dropdown + id: script + attributes: + label: Which script is affected? + options: + - sp_HealthParser + - sp_HumanEvents + - sp_IndexCleanup + - sp_LogHunter + - sp_PerfCheck + - sp_PressureDetector + - sp_QueryReproBuilder + - sp_QueryStoreCleanup + - sp_QuickieStore + - Other (specify in description) + validations: + required: true + + - type: input + id: version + attributes: + label: Script Version + description: Look near the top of the stored procedure for the version date and number. + placeholder: "e.g., 2026.03.15, v4.2" + validations: + required: true + + - type: markdown + attributes: + value: | + > If you're not on the current version (dated in the last month), upgrade and retest before reporting. We fix a lot of stuff in each build and will close bug reports for older versions. + + - 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: 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? Include the parameters you used. + placeholder: | + 1. Execute sp_QuickieStore with @database_name = '...', @sort_order = '...' + 2. 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. Include the full error message if there is one. + validations: + required: true + + - type: textarea + id: errors + attributes: + label: Error Messages + description: Paste the full error message, if any. + render: text + validations: + required: false + + - type: textarea + id: context + attributes: + label: Additional Context + description: | + Anything else that might help: + - Did this work in a previous version? + - Are you running on Azure SQL DB, Azure MI, or AWS RDS? + - Any relevant server configuration (compatibility level, etc.)? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..27be50d9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Questions & Discussion + url: https://github.com/erikdarlingdata/DarlingData/discussions + about: Ask questions and discuss DarlingData scripts with the community diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 2ef448de..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - -**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. - -**Are you ready to build the code for the feature?** -As much as we'd love to build everything that everyone wants for free, we need your help. Open source is built with your help and code. Are you ready to commit time to this project? Have you got existing code you can help contribute to solve the problem? - -**IMPORTANT: If you're going to contribute code, please read the contributing guide first.** -https://github.com/erikdarlingdata/DarlingData/blob/main/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..3cc2a033 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,65 @@ +name: Feature Request +description: Suggest a new feature or enhancement +title: "[FEATURE] " +labels: ["enhancement"] + +body: + - type: checkboxes + id: script + attributes: + label: Which script(s) does this affect? + options: + - label: sp_HealthParser + - label: sp_HumanEvents + - label: sp_IndexCleanup + - label: sp_LogHunter + - label: sp_PerfCheck + - label: sp_PressureDetector + - label: sp_QueryReproBuilder + - label: sp_QueryStoreCleanup + - label: sp_QuickieStore + - label: Other / new script + 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: checkboxes + id: contribution + attributes: + label: Contribution + description: "Open source is built with your help. If you're going to contribute code, please read the [contributing guide](https://github.com/erikdarlingdata/DarlingData/blob/main/CONTRIBUTING.md) first." + options: + - label: I'm willing to contribute code for this feature + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index b7267999..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Question -about: I have a question about your scripts ---- - -**Which script is your question about?** - -Script Name: - -**Script version** - -All scripts have a version and version date. Make sure you're on a recent version. - -**Is your question about how they work, or the results?** - -Questions about *how the scripts work* can be answered here. - -If you have questions about the results, performance tuning, or SQL Server in general, you'll wanna hit a Q&A site like: -* https://topanswers.xyz/databases -* https://dba.stackexchange.com/ - -**Okay, what's your question?** - -Enter your query and press F5. - -**IMPORTANT: If you're going to contribute code, please read the contributing guide first.** -https://github.com/erikdarlingdata/DarlingData/blob/main/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..1107aa82 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,64 @@ +name: Question +description: I have a question about a stored procedure +title: "[QUESTION] " +labels: ["question"] + +body: + - type: dropdown + id: script + attributes: + label: Which script is your question about? + options: + - sp_HealthParser + - sp_HumanEvents + - sp_IndexCleanup + - sp_LogHunter + - sp_PerfCheck + - sp_PressureDetector + - sp_QueryReproBuilder + - sp_QueryStoreCleanup + - sp_QuickieStore + - Other + validations: + required: true + + - type: input + id: version + attributes: + label: Script Version + description: All scripts have a version and version date near the top. Make sure you're on a recent version. + placeholder: "e.g., 2026.03.15, v4.2" + validations: + required: true + + - type: dropdown + id: question-type + attributes: + label: Is your question about how it works, or the results? + description: Questions about results, performance tuning, or SQL Server in general are better suited for https://www.erikdarling.com/ or https://dba.stackexchange.com/ + options: + - How the script 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