-
Notifications
You must be signed in to change notification settings - Fork 53
NEW: @W-17616013@: Add in code analyzer issue template #1726
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| name: Report a Bug with a code-analyzer command | ||
| description: Report an issue with a code-analyzer command. | ||
| title: "[BUG][code-analyzer] <YOUR_TITLE_HERE>" | ||
| labels: [] | ||
| body: | ||
| - type: dropdown | ||
| attributes: | ||
| label: Have you tried to resolve this issue yourself first? | ||
| description: | | ||
| Oftentimes, you can resolve `code-analyzer` issues on your own. Follow these steps: | ||
| 1. Read the error message. | ||
| 2. Read [Salesforce Code Analyzer](https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/guide/code-analyzer.html) documentation. | ||
| 3. Double-check the command that you ran. Ensure that items like file names, method names, and category names are correctly spelled and cased. | ||
| 4. Verify that your code is syntactically valid. | ||
| 5. Verify that the error is reproducible on another machine. | ||
| 6. Check open and closed [issues](https://github.com/forcedotcom/sfdx-scanner/issues) to see if your issue is already logged. | ||
|
|
||
| **I confirm that I have gone through these steps and still have an issue to report.** | ||
| <sup>(You must select "Yes" to create an issue.)</sup> | ||
| options: | ||
| - '' | ||
| - "Yes" | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Bug Description | ||
| description: Provide a clear and concise description of what the bug is and include the exact command that you ran. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Output / Logs | ||
| description: Attach any output or logs here | ||
| placeholder: | | ||
| Add log output here or drag files here. | ||
| - type: textarea | ||
| attributes: | ||
| label: Steps To Reproduce | ||
| description: List out the steps that you used to reproduce the bug behavior. Be as specific and clear as possible. | ||
| placeholder: | | ||
| 1. I first do ... | ||
| 2. Then I do ... | ||
| 3. Lastly, I do ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: Provide a clear and concise description of what you expected to happen. | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Operating System | ||
| description: | | ||
| What is your machine's operating system? | ||
| placeholder: | | ||
| Example: MacOS Sonoma 14.4.1 | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Salesforce CLI Version | ||
| description: | | ||
| What do you get from the command "sf --version"? | ||
| placeholder: | | ||
| Example: @salesforce/cli/2.40.7 darwin-arm64 node-v20.12.2 | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Code Analyzer Plugin (code-analyzer) Version | ||
| description: | | ||
| What do you get from the command "sf plugins"? | ||
| placeholder: | | ||
| Example: code-analyzer 5.0.0-beta.0 | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Node Version | ||
| description: | | ||
| What do you get from the command "node --version"? | ||
| placeholder: | | ||
| Example: v23.4.0 | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| attributes: | ||
| label: Java Version | ||
| description: | | ||
| What do you get from the command "java -version"? | ||
| placeholder: | | ||
| Example: openjdk version "11.0.17.0.1" 2022-10-18 LTS | ||
| validations: | ||
| required: false | ||
| - type: input | ||
| attributes: | ||
| label: Python Version | ||
| description: | | ||
| What do you get from the command "python --version"? | ||
| placeholder: | | ||
| Example: Python 3.11.8 | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| attributes: | ||
| label: Additional Context (Screenshots, Files, etc) | ||
| description: Add any other context about the problem. | ||
| placeholder: | | ||
| Drag any files or screenshots you have here. | ||
| - type: textarea | ||
| attributes: | ||
| label: Workaround | ||
| description: What ways have you found to sidestep the problem? If you haven't found a workaround, what have you tried so far? | ||
| - type: dropdown | ||
| attributes: | ||
| label: Urgency | ||
| description: What is the severity of the problem? | ||
| options: | ||
| - Low | ||
| - Moderate | ||
| - High | ||
| - Critical | ||
| default: 0 | ||
| validations: | ||
| required: true | ||
2 changes: 1 addition & 1 deletion
2
.github/ISSUE_TEMPLATE/0-scanner_run_bug.yml → .github/ISSUE_TEMPLATE/1-scanner_run_bug.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
.../ISSUE_TEMPLATE/1-scanner_run_dfa_bug.yml → .../ISSUE_TEMPLATE/2-scanner_run_dfa_bug.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...E_TEMPLATE/2-scanner_run_false_result.yml → ...E_TEMPLATE/3-scanner_run_false_result.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...MPLATE/3-scanner_run_dfa_false_result.yml → ...MPLATE/4-scanner_run_dfa_false_result.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of this was copied and pasted from the other issue templates with just a few minor changes so that it says "code-analyzer" instead of "scanner".