Skip to content

Commit b31d65b

Browse files
stephen-carter-at-sfstephen-carter-at-sf
authored
Merge pull request #1726 from forcedotcom/sc/W-17616013
NEW: @W-17616013@: Add in code analyzer issue template
2 parents 011897f + 28a8cee commit b31d65b

File tree

6 files changed

+132
-4
lines changed

6 files changed

+132
-4
lines changed

‎.github/ISSUE_TEMPLATE/0-code_analyzer_bug.yml‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
name: Report a Bug with a code-analyzer command
2+
description: Report an issue with a code-analyzer command.
3+
title: "[BUG][code-analyzer] <YOUR_TITLE_HERE>"
4+
labels: []
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Have you tried to resolve this issue yourself first?
9+
description: |
10+
Oftentimes, you can resolve `code-analyzer` issues on your own. Follow these steps:
11+
1. Read the error message.
12+
2. Read [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer.html) documentation.
13+
3. Double-check the command that you ran. Ensure that items like file names, method names, and category names are correctly spelled and cased.
14+
4. Verify that your code is syntactically valid.
15+
5. Verify that the error is reproducible on another machine.
16+
6. Check open and closed [issues](https://github.com/forcedotcom/sfdx-scanner/issues) to see if your issue is already logged.
17+
18+
**I confirm that I have gone through these steps and still have an issue to report.**
19+
<sup>(You must select "Yes" to create an issue.)</sup>
20+
options:
21+
- ''
22+
- "Yes"
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Bug Description
28+
description: Provide a clear and concise description of what the bug is and include the exact command that you ran.
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Output / Logs
34+
description: Attach any output or logs here
35+
placeholder: |
36+
Add log output here or drag files here.
37+
- type: textarea
38+
attributes:
39+
label: Steps To Reproduce
40+
description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.
41+
placeholder: |
42+
1. I first do ...
43+
2. Then I do ...
44+
3. Lastly, I do ...
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Expected Behavior
50+
description: Provide a clear and concise description of what you expected to happen.
51+
validations:
52+
required: true
53+
- type: input
54+
attributes:
55+
label: Operating System
56+
description: |
57+
What is your machine's operating system?
58+
placeholder: |
59+
Example: MacOS Sonoma 14.4.1
60+
validations:
61+
required: true
62+
- type: input
63+
attributes:
64+
label: Salesforce CLI Version
65+
description: |
66+
What do you get from the command "sf --version"?
67+
placeholder: |
68+
Example: @salesforce/cli/2.40.7 darwin-arm64 node-v20.12.2
69+
validations:
70+
required: true
71+
- type: input
72+
attributes:
73+
label: Code Analyzer Plugin (code-analyzer) Version
74+
description: |
75+
What do you get from the command "sf plugins"?
76+
placeholder: |
77+
Example: code-analyzer 5.0.0-beta.0
78+
validations:
79+
required: true
80+
- type: input
81+
attributes:
82+
label: Node Version
83+
description: |
84+
What do you get from the command "node --version"?
85+
placeholder: |
86+
Example: v23.4.0
87+
validations:
88+
required: false
89+
- type: input
90+
attributes:
91+
label: Java Version
92+
description: |
93+
What do you get from the command "java -version"?
94+
placeholder: |
95+
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
96+
validations:
97+
required: false
98+
- type: input
99+
attributes:
100+
label: Python Version
101+
description: |
102+
What do you get from the command "python --version"?
103+
placeholder: |
104+
Example: Python 3.11.8
105+
validations:
106+
required: false
107+
- type: textarea
108+
attributes:
109+
label: Additional Context (Screenshots, Files, etc)
110+
description: Add any other context about the problem.
111+
placeholder: |
112+
Drag any files or screenshots you have here.
113+
- type: textarea
114+
attributes:
115+
label: Workaround
116+
description: What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?
117+
- type: dropdown
118+
attributes:
119+
label: Urgency
120+
description: What is the severity of the problem?
121+
options:
122+
- Low
123+
- Moderate
124+
- High
125+
- Critical
126+
default: 0
127+
validations:
128+
required: true

.github/ISSUE_TEMPLATE/0-scanner_run_bug.yml renamed to .github/ISSUE_TEMPLATE/1-scanner_run_bug.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Report a Bug with scanner run
22
description: Report an issue with the scanner run command.
3-
title: "[BUG] <YOUR_TITLE_HERE>"
3+
title: "[BUG][scanner run] <YOUR_TITLE_HERE>"
44
labels: []
55
body:
66
- type: dropdown

.github/ISSUE_TEMPLATE/1-scanner_run_dfa_bug.yml renamed to .github/ISSUE_TEMPLATE/2-scanner_run_dfa_bug.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Report a Bug with scanner run dfa
22
description: Report an issue with the scanner run dfa command.
3-
title: "[BUG] <YOUR_TITLE_HERE>"
3+
title: "[BUG][scanner run dfa] <YOUR_TITLE_HERE>"
44
labels: []
55
body:
66
- type: dropdown

.github/ISSUE_TEMPLATE/2-scanner_run_false_result.yml renamed to .github/ISSUE_TEMPLATE/3-scanner_run_false_result.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Report a False Result with scanner run
22
description: Report false results in scanner run scan reports. If you're submitting your managed package for AppExchange security review, include documentation of your false results with your submission.
3-
title: "[False Result] <YOUR_TITLE_HERE>"
3+
title: "[False Result][scanner run] <YOUR_TITLE_HERE>"
44
labels: []
55
body:
66
- type: dropdown

.github/ISSUE_TEMPLATE/3-scanner_run_dfa_false_result.yml renamed to .github/ISSUE_TEMPLATE/4-scanner_run_dfa_false_result.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: Report a False Result with scanner run dfa
22
description: Report false results returned in scanner run dfa scan reports. If you're submitting for AppExchange security review, include documentation of your false results with your submission.
3-
title: "[False Result] <YOUR_TITLE_HERE>"
3+
title: "[False Result][scanner run dfa] <YOUR_TITLE_HERE>"
44
labels: []
55
body:
66
- type: textarea

.github/ISSUE_TEMPLATE/4-feature_request.yml renamed to .github/ISSUE_TEMPLATE/5-feature_request.yml

File renamed without changes.

0 commit comments

Comments
 (0)