0-code_analyzer_bug.yml

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: checkboxes
    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/code-analyzer/issues) to see if your issue is already logged.
      options:
        - label: I confirm I have gone through the above steps and still have an issue to report
          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
    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