reference/code/Diffulex-mbd-lms/.github/ISSUE_TEMPLATE/bug-report.yml

name: 🐛 Bug Report
description: File an issue about a bug.
title: "[BUG] "
labels: [bug]
assignees: []
body:
  - type: markdown
    attributes:
      value: >-
        Please do your best to make the issue as easy to act on as possible,
        and only submit here if there is clearly a problem with Diffulex.

  - type: checkboxes
    id: steps
    attributes:
      label: Required prerequisites
      description: Make sure you've completed the following steps before submitting your issue -- thank you!
      options:
        - label: I have read the project documentation <https://github.com/SJTU-DENG-Lab/Diffulex#readme>.
          required: true
        - label: >-
            I have searched the [Issue Tracker](https://github.com/SJTU-DENG-Lab/Diffulex/issues)
            that this hasn't already been reported. (comment there if it has.)
          required: true

  - type: input
    id: version
    attributes:
      label: What version/commit of Diffulex are you using?
      description: >-
        If you installed from package, provide the package version. If you are using source code,
        run `git rev-parse --short HEAD` in your local checkout and paste the output here.
      placeholder: E.g., 0.1.5 or a1b2c3d
    validations:
      required: true

  - type: textarea
    id: system-info
    attributes:
      label: System information
      description: |
        Describe the characteristic of your environment:

        - Describe how the library was installed (pip, conda, source, ...)
        - Python version
        - Versions of any other relevant libraries

        ```python
        import sys, torch
        print(sys.version, sys.platform)
        print(torch.__version__)
        ```

        ```bash
        python3 -m torch.utils.collect_env
        ```
    validations:
      required: true

  - type: textarea
    id: description
    attributes:
      label: Problem description
      description: >-
        Provide a short description, state the expected behavior and what actually happens. Include
        relevant information like what version/commit of Diffulex you are using, what system you are on, and
        any useful commands / output.
    validations:
      required: true

  - type: textarea
    id: code
    attributes:
      label: Reproducible example code
      description: >-
        The code should be minimal, have minimal external dependencies, and isolate the functions
        that cause breakage. Submit matched and complete snippets that can be easily run to diagnose
        the issue.
      value: |
        The Python snippets:

        ```python

        ```
    validations:
      required: true

  - type: textarea
    id: traceback
    attributes:
      label: Traceback
      description: Put the Python traceback information here.
      placeholder: |
        Traceback (most recent call last):
          File ...
      render: pytb

  - type: textarea
    id: expected
    attributes:
      label: Expected behavior
      description: Provide a clear and concise description of what you expected to happen.

  - type: textarea
    id: additional-context
    attributes:
      label: Additional context
      description: >-
        Add any other context about the problem here. Screenshots may also be helpful.

        If you know or suspect the reason for this bug, paste the code lines and suggest modifications.