bug_report.yml

name: 🛠 Bug report
description: Create a report to help us improve
title: Good bug title tells us about precise symptom, not about the root cause.
labels: [bug]
body:
  - type: textarea
    id: description
    attributes:
      label: Description
      description: |
        A clear and concise description of what the bug is
    validations:
      required: true
  - type: textarea
    id: steps-to-reproduce
    attributes:
      label: Steps to reproduce
      description: Steps to reproduce the behavior
      placeholder: |
        1. Run ...
        2. ...
        3. ...
    validations:
      required: true
  - type: textarea
    id: current-behavior
    attributes:
      label: Current behavior
      description: What happens actually so you think this is a bug.
    validations:
      required: true
  - type: textarea
    id: desired-behavior
    attributes:
      label: Desired behavior
      description: |
        A clear and concise description of what you expected to happen.
    validations:
      required: true
  - type: textarea
    id: screenshots
    attributes:
      label: Screenshots
      description: |
        If applicable, add screenshots to help explain your problem.
  - type: textarea
    id: environment
    attributes:
      label: Environment
      description: |
        Please use the following command to retrieve environment information

        ```bash
        cz version --report
        ```

        If `cz version --report` is not available, please run the following commands to retrieve your environment information:

        ```bash
        echo "Commitizen Version: $(cz version)"
        echo "Python Version: $(python3 -c 'import sys; print(sys.version)')"
        echo "Operating System: $(python3 -c 'import platform; print(platform.system())')"
        ```
      placeholder: |
        Commitizen Version: 4.0.0
        Python Version: 3.13.3 (main, Apr  8 2025, 13:54:08) [Clang 16.0.0 (clang-1600.0.26.6)]
        Operating System: Darwin
    validations:
      required: true