bug-report.yml

name: Bug report
description: Report a bug in SimPEG.
title: "BUG: <Please write a comprehensive title after the 'BUG: ' prefix>"
labels: ["bug"]

body:
- type: markdown
  attributes:
    value: >
      Thanks for using SimPEG and taking the time to report a bug! Please
      first double check that there is not already a bug report on this issue by
      searching through the existing bugs.

- type: textarea
  attributes:
    label: "Describe the issue:"
  validations:
    required: true

- type: textarea
  attributes:
    label: "Reproducible code example:"
    description: >
      Please submit a small, but complete, code sample that reproduces the
      bug or missing functionality. It should be able to be copy-pasted
      into a Python interpreter and run as-is.
    placeholder: |
      import simpeg
      << your code here >>
    render: python
  validations:
    required: true

- type: textarea
  attributes:
    label: "Error message:"
    description: >
      Please include full error message, if any.
    placeholder: |
      << Full traceback starting from `Traceback: ...` >>
    render: shell

- type: textarea
  attributes:
    label: "Runtime information:"
    description: >
      Please include the output from `simpeg.Report()` to describe your system for us.
      Paste the output from `from simpeg import Report; print(Report())` below.
    render: shell
  validations:
    required: true

- type: textarea
  attributes:
    label: "Context for the issue:"
    description: |
      If you would like to give a little context for the issue, let us know and
      it will help us to prioritize the issue.
    placeholder: |
      << your explanation here >>
  validations:
    required: false