/ .github / ISSUE_TEMPLATE / bug_report.yaml
bug_report.yaml
 1  name: 🐛 Bug Report
 2  description: Create a report to help us reproduce and fix the bug
 3  
 4  body:
 5  - type: markdown
 6    attributes:
 7      value: >
 8        #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/linkedin/Liger-Kernel/issues).
 9  - type: textarea
10    attributes:
11      label: 🐛 Describe the bug
12      description: |
13        Please provide a clear and concise description of what the bug is.
14      placeholder: |
15        A clear and concise description of what the bug is.
16    validations:
17      required: true
18  
19  - type: textarea
20    attributes:
21      label: Reproduce
22      description: |
23        If applicable, add a minimal example so that we can reproduce the error by running the code.
24        The snippet needs to be as succinct (minimal) as possible, so please take time to trim down any irrelevant code to help us debug efficiently.
25        We are going to copy-paste your code and we expect to get the same result as you did: avoid any external data, and include the relevant imports, etc.
26        If the code is too long (hopefully, it isn't), feel free to put it in a public gist and link it in the issue: https://gist.github.com.
27        Please also paste or describe the results you observe instead of the expected results.
28        If you observe an error, please paste the error message including the **full** traceback of the exception.
29    validations:
30      required: false
31  
32  - type: textarea
33    attributes:
34      label: Versions
35      description: |
36        Please provide triton, torch, hardware, and other necessary versions to reproduce the bug.
37  
38        For convenience, you can run the following command to get the versions of important software dependencies:
39        ```bash
40        python -m liger_kernel.env_report
41        ```
42    validations:
43      required: true
44  
45  - type: markdown
46    attributes:
47      value: >
48        Thanks for contributing 🎉!