Skip to content

Commit 5bb8d81

Browse files
authored
Merge pull request #4887 from rubberduck-vba/moar-templates
Added feature request templates
2 parents 7bf56f5 + 256ef34 commit 5bb8d81

File tree

3 files changed

+65
-0
lines changed

3 files changed

+65
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ labels: bug
66
assignees: ''
77

88
---
9+
910
**Rubberduck version information**
1011
The info below can be copy-paste-completed from the first lines of Rubberduck's log or the About box:
1112

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Feature request (inspection)
3+
about: Suggest something Rubberduck could find in user code and warn about
4+
title: ''
5+
labels: enhancement, feature-inspections, up-for-grabs
6+
assignees: ''
7+
8+
---
9+
10+
**What**
11+
Describe what the new inspection should find in the user's VBA code; identify the type of inspection: is it about code quality (e.g. potential bugs), is it more of a language opportunity (e.g. obsolete statements), a performance opportunity (e.g. iterating an array with a `For Each` loop), or a Rubberduck opportunity (e.g. something Rubberduck can do or help with, but needs the user code to be modified a bit).
12+
13+
**Why**
14+
Describe the rationale behind this inspection - *why* finding what we're looking for in the user's code is noteworthy: justify the inspection.
15+
16+
**Example**
17+
This code should trigger the inspection:
18+
19+
```vb
20+
Public Sub DoSomething()
21+
'...
22+
End Sub
23+
```
24+
25+
---
26+
27+
**QuickFixes**
28+
Should Rubberduck offer one or more quickfix(es) for this inspection? Describe them here (note: all inspections allow for `IgnoreOnceQuickFix`, unless explicitly specified):
29+
30+
1. **QuickFix Name**
31+
32+
Example code, after quickfix is applied:
33+
34+
```vb
35+
Public Sub DoSomething()
36+
'...
37+
End Sub
38+
```
39+
40+
---
41+
42+
**Resources**
43+
Each inspection needs a number of resource strings - please provide a suggestion here:
44+
45+
- **InspectionNames**: the name of the inspection, as it appears in the inspection settings.
46+
- **InspectionInfo**: the detailed rationale for the inspection, as it appears in the inspection results toolwindow's bottom panel.
47+
- **InspectionResults**: the resource string for an inspection result; if the string needs placeholders, identify what goes in for them (e.g. `Variable {0} is not used`, {0}:the name of the variable).
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for a new feature other than a new code inspection
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Justification**
11+
A clear and concise description of the problem that justifies the introduction of this feature.
12+
13+
**Description**
14+
A clear and concise description of what you want to happen.
15+
16+
**Additional context**
17+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)