Skip to content

Commit f43fb46

Browse files
erikdarlingdataerikdarlingdata
authored
Merge pull request #696 from erikdarlingdata/feature/issue-templates-yml
Replace markdown issue templates with YAML issue forms
2 parents cc35de9 + 00ee0ba commit f43fb46

7 files changed

Lines changed: 236 additions & 66 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 19 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: Bug Report
2+
description: Report a problem with a stored procedure
3+
title: "[BUG] "
4+
labels: ["bug"]
5+
6+
body:
7+
- type: dropdown
8+
id: script
9+
attributes:
10+
label: Which script is affected?
11+
options:
12+
- sp_HealthParser
13+
- sp_HumanEvents
14+
- sp_IndexCleanup
15+
- sp_LogHunter
16+
- sp_PerfCheck
17+
- sp_PressureDetector
18+
- sp_QueryReproBuilder
19+
- sp_QueryStoreCleanup
20+
- sp_QuickieStore
21+
- Other (specify in description)
22+
validations:
23+
required: true
24+
25+
- type: input
26+
id: version
27+
attributes:
28+
label: Script Version
29+
description: Look near the top of the stored procedure for the version date and number.
30+
placeholder: "e.g., 2026.03.15, v4.2"
31+
validations:
32+
required: true
33+
34+
- type: markdown
35+
attributes:
36+
value: |
37+
> 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.
38+
39+
- type: input
40+
id: sql-version
41+
attributes:
42+
label: SQL Server Version
43+
description: "Run SELECT @@VERSION on the target server."
44+
placeholder: "e.g., SQL Server 2019 CU25"
45+
validations:
46+
required: true
47+
48+
- type: textarea
49+
id: description
50+
attributes:
51+
label: Describe the Bug
52+
description: A clear description of what the bug is.
53+
validations:
54+
required: true
55+
56+
- type: textarea
57+
id: steps
58+
attributes:
59+
label: Steps to Reproduce
60+
description: How can we reproduce this? Include the parameters you used.
61+
placeholder: |
62+
1. Execute sp_QuickieStore with @database_name = '...', @sort_order = '...'
63+
2. See error
64+
validations:
65+
required: true
66+
67+
- type: textarea
68+
id: expected
69+
attributes:
70+
label: Expected Behavior
71+
description: What you expected to happen.
72+
validations:
73+
required: true
74+
75+
- type: textarea
76+
id: actual
77+
attributes:
78+
label: Actual Behavior
79+
description: What actually happened. Include the full error message if there is one.
80+
validations:
81+
required: true
82+
83+
- type: textarea
84+
id: errors
85+
attributes:
86+
label: Error Messages
87+
description: Paste the full error message, if any.
88+
render: text
89+
validations:
90+
required: false
91+
92+
- type: textarea
93+
id: context
94+
attributes:
95+
label: Additional Context
96+
description: |
97+
Anything else that might help:
98+
- Did this work in a previous version?
99+
- Are you running on Azure SQL DB, Azure MI, or AWS RDS?
100+
- Any relevant server configuration (compatibility level, etc.)?
101+
validations:
102+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions & Discussion
4+
url: https://github.com/erikdarlingdata/DarlingData/discussions
5+
about: Ask questions and discuss DarlingData scripts with the community

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[FEATURE] "
4+
labels: ["enhancement"]
5+
6+
body:
7+
- type: checkboxes
8+
id: script
9+
attributes:
10+
label: Which script(s) does this affect?
11+
options:
12+
- label: sp_HealthParser
13+
- label: sp_HumanEvents
14+
- label: sp_IndexCleanup
15+
- label: sp_LogHunter
16+
- label: sp_PerfCheck
17+
- label: sp_PressureDetector
18+
- label: sp_QueryReproBuilder
19+
- label: sp_QueryStoreCleanup
20+
- label: sp_QuickieStore
21+
- label: Other / new script
22+
validations:
23+
required: true
24+
25+
- type: textarea
26+
id: problem
27+
attributes:
28+
label: Problem Statement
29+
description: Describe the problem you're trying to solve or the limitation you're facing.
30+
validations:
31+
required: true
32+
33+
- type: textarea
34+
id: solution
35+
attributes:
36+
label: Proposed Solution
37+
description: Describe your proposed feature or enhancement.
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: use-case
43+
attributes:
44+
label: Use Case
45+
description: How would you use this feature? Provide a specific example.
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: alternatives
51+
attributes:
52+
label: Alternatives Considered
53+
description: Have you considered any alternative solutions or workarounds?
54+
validations:
55+
required: false
56+
57+
- type: checkboxes
58+
id: contribution
59+
attributes:
60+
label: Contribution
61+
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."
62+
options:
63+
- label: I'm willing to contribute code for this feature
64+
validations:
65+
required: false

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Question
2+
description: I have a question about a stored procedure
3+
title: "[QUESTION] "
4+
labels: ["question"]
5+
6+
body:
7+
- type: dropdown
8+
id: script
9+
attributes:
10+
label: Which script is your question about?
11+
options:
12+
- sp_HealthParser
13+
- sp_HumanEvents
14+
- sp_IndexCleanup
15+
- sp_LogHunter
16+
- sp_PerfCheck
17+
- sp_PressureDetector
18+
- sp_QueryReproBuilder
19+
- sp_QueryStoreCleanup
20+
- sp_QuickieStore
21+
- Other
22+
validations:
23+
required: true
24+
25+
- type: input
26+
id: version
27+
attributes:
28+
label: Script Version
29+
description: All scripts have a version and version date near the top. Make sure you're on a recent version.
30+
placeholder: "e.g., 2026.03.15, v4.2"
31+
validations:
32+
required: true
33+
34+
- type: dropdown
35+
id: question-type
36+
attributes:
37+
label: Is your question about how it works, or the results?
38+
description: Questions about results, performance tuning, or SQL Server in general are better suited for https://www.erikdarling.com/ or https://dba.stackexchange.com/
39+
options:
40+
- How the script works
41+
- Setup / installation
42+
- Results / data interpretation
43+
- Contributing / development
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: question
49+
attributes:
50+
label: What's your question?
51+
description: A clear description of what you'd like to know.
52+
validations:
53+
required: true
54+
55+
- type: textarea
56+
id: context
57+
attributes:
58+
label: Additional Context
59+
description: |
60+
Anything that might help:
61+
- SQL Server version and edition
62+
- Are you using Azure SQL DB, Azure MI, or AWS RDS?
63+
validations:
64+
required: false

0 commit comments

Comments
 (0)