Skip to content

Commit 7174dcf

Browse files
stephen-carter-at-sfstephen-carter-at-sf
authored
CHANGE(CodeAnalyzer): @W-15794148@ Convert issue templates to be form based (#1472)
1 parent 7cd3df8 commit 7174dcf

10 files changed

+431
-251
lines changed

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

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
name: Report a Bug with scanner run
2+
description: Report an issue with the scanner run command.
3+
title: "[BUG] <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 `scanner run` 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/overview) 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. Attempt to reproduce the error by running against that engine directly instead of via the Code Analyzer. If you can reproduce the error, create an issue on that engine's repo instead of on Code Analyzer's repo.
17+
7. Check open and closed [issues](https://github.com/forcedotcom/sfdx-scanner/issues) to see if your issue is already logged.
18+
19+
If you're listing a managed package on AppExchange, prepare for the security review by following the instructions in the [Scan Your Solution with Salesforce Code Analyzer](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_code_analyzer_scan.htm) section of the ISVforce Guide.
20+
21+
**I confirm that I have gone through these steps and still have an issue to report.**
22+
<sup>(You must select "Yes" to create an issue.)</sup>
23+
options:
24+
- ''
25+
- "Yes"
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Bug Description
31+
description: Provide a clear and concise description of what the bug is.
32+
validations:
33+
required: true
34+
- type: textarea
35+
attributes:
36+
label: Output / Logs
37+
description: Attach any output or logs here
38+
render: shell
39+
- type: textarea
40+
attributes:
41+
label: Steps To Reproduce
42+
description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.
43+
placeholder: |
44+
1. I first do ...
45+
2. Then I do ...
46+
3. Lastly, I do ...
47+
validations:
48+
required: true
49+
- type: textarea
50+
attributes:
51+
label: Expected Behavior
52+
description: Provide a clear and concise description of what you expected to happen.
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 (@salesforce/sfdx-scanner) Version
74+
description: |
75+
What do you get from the command "sf plugins"?
76+
placeholder: |
77+
Example: @salesforce/sfdx-scanner 4.1.0 (latest-beta)
78+
validations:
79+
required: true
80+
- type: textarea
81+
attributes:
82+
label: Additional Context (Screenshots, Files, etc)
83+
description: Add any other context about the problem.
84+
placeholder: |
85+
Drag any files or screenshots you have here.
86+
- type: textarea
87+
attributes:
88+
label: Workaround
89+
description: What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?
90+
- type: dropdown
91+
attributes:
92+
label: Urgency
93+
description: What is the severity of the problem?
94+
options:
95+
- Low
96+
- Moderate
97+
- High
98+
- Critical
99+
default: 0
100+
validations:
101+
required: true

‎.github/ISSUE_TEMPLATE/0scanner_run_bug.md‎

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

‎.github/ISSUE_TEMPLATE/1-scanner_run_dfa_bug.yml‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
name: Report a Bug with scanner run dfa
2+
description: Report an issue with the scanner run dfa command.
3+
title: "[BUG] <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 `scanner run dfa` issues on your own. Follow these steps:
11+
1. Read the error message.
12+
2. Read [Salesforce Graph Engine](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/salesforce-graph-engine.html) documentation.
13+
3. Read our guide for [troubleshooting Graph Engine errors](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/troubleshooting.html).
14+
4. Read our guidelines to resolve [LimitReached errors](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/working-with-graph-engine.html#limitreached-errors) and [path evaluation timeouts](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/troubleshooting.html#issues-using-salesforce-graph-engine).
15+
5. Read our [Guide to Writing Graph Engine-Friendly Code](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/graph-engine-friendly-code.html).
16+
6. Double-check the command that you entered. Ensure that items like file names, method names, and category names are correctly spelled and cased.
17+
7. Verify that your code is syntactically valid.
18+
8. Verify that the error is reproducible on another machine.
19+
9. Check open and closed [issues](https://github.com/forcedotcom/sfdx-scanner/issues) to see if your issue is already logged.
20+
10. If there's no existing issue that covers your situation, log a new issue.
21+
22+
If you're listing a managed package on AppExchange, prepare for the security review by following the instructions in the [Scan Your Solution with Salesforce Code Analyzer](https://developer.salesforce.com/docs/atlas.en-us.packagingGuide.meta/packagingGuide/security_review_code_analyzer_scan.htm) section of the ISVforce Guide.
23+
*Note: In your scan report, if you see an InternalExecutionError or a LimitReached error, you can still submit for AppExchange security review. These errors aren't blockers.*
24+
25+
**I confirm that I have gone through these steps and still have an issue to report.**
26+
<sup>(You must select "Yes" to create an issue.)</sup>
27+
options:
28+
- ''
29+
- "Yes"
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: Bug Description
35+
description: Provide a clear and concise description of what the bug is.
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Output / Logs
41+
description: Attach any output or logs here. The log for the Salesforce Graph Engine can be found in `~/.sfdx-scanner/sfge.log`. If the error message mentions a specific graph vertex, check its DefiningType and BeginLine properties and include the code at that line.
42+
render: shell
43+
- type: textarea
44+
attributes:
45+
label: Steps To Reproduce
46+
description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible.
47+
placeholder: |
48+
1. I first do ...
49+
2. Then I do ...
50+
3. Lastly, I do ...
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: Expected Behavior
56+
description: Provide a clear and concise description of what you expected to happen.
57+
- type: input
58+
attributes:
59+
label: Operating System
60+
description: |
61+
What is your machine's operating system?
62+
placeholder: |
63+
Example: MacOS Sonoma 14.4.1
64+
validations:
65+
required: true
66+
- type: input
67+
attributes:
68+
label: Salesforce CLI Version
69+
description: |
70+
What do you get from the command "sf --version"?
71+
placeholder: |
72+
Example: @salesforce/cli/2.40.7 darwin-arm64 node-v20.12.2
73+
validations:
74+
required: true
75+
- type: input
76+
attributes:
77+
label: Code Analyzer Plugin (@salesforce/sfdx-scanner) Version
78+
description: |
79+
What do you get from the command "sf plugins"?
80+
placeholder: |
81+
Example: @salesforce/sfdx-scanner 4.1.0 (latest-beta)
82+
validations:
83+
required: true
84+
- type: input
85+
attributes:
86+
label: Java Version
87+
description: |
88+
What do you get from the command "java -version"?
89+
placeholder: |
90+
Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS
91+
validations:
92+
required: true
93+
- type: textarea
94+
attributes:
95+
label: Additional Context (Screenshots, Files, etc)
96+
description: Add any other context about the problem.
97+
placeholder: |
98+
Drag any files or screenshots you have here.
99+
- type: textarea
100+
attributes:
101+
label: Workaround
102+
description: What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far?
103+
- type: dropdown
104+
attributes:
105+
label: Urgency
106+
description: What is the severity of the problem?
107+
options:
108+
- Low
109+
- Moderate
110+
- High
111+
- Critical
112+
default: 0
113+
validations:
114+
required: true

‎.github/ISSUE_TEMPLATE/1scanner_run_dfa_bug.md‎

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

0 commit comments

Comments
 (0)