Skip to content

Commit 379dbb5

Browse files
AkilsuryaSRBendias
andauthored
Add required bug report issue form (#1333)
# Summary Adds a bug-report form so reports include the details needed to reproduce a problem. # Description of the change Requires a complete minimal reproducer, full error messages or observed output, and environment details. The form also asks for expected versus actual behavior and explains how to collect PyTorch environment information. Targets the default branch because GitHub loads issue forms from there. Fixes #1248. # Validation Validated the form against the issue-form JSON schema and checked that all four required fields start empty. Confirmed that the suggested environment command runs locally. GitHub's rendered form still needs verification after merging. --------- Signed-off-by: AKILSURYA SIVAKUMAR <akilsurya20399@gmail.com> Signed-off-by: RBendias <rbendias@nvidia.com> Co-authored-by: RBendias <rbendias@nvidia.com>
1 parent c51bc37 commit 379dbb5

1 file changed

Lines changed: 59 additions & 0 deletions

File tree

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us reproduce and fix the bug
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to report this problem! Issues that do not follow the checklist below may be closed.
9+
- type: checkboxes
10+
attributes:
11+
label: Checklist
12+
description: Please confirm the following before submitting.
13+
options:
14+
- label: I have reviewed the [contributing guidelines](https://github.com/Nvidia/structured-data-models/blob/main/CONTRIBUTING.md) and [AI policy](https://github.com/Nvidia/structured-data-models/blob/main/AGENTS.md#ai-policy).
15+
required: true
16+
- label: I have searched the [existing and past issues](https://github.com/Nvidia/structured-data-models/issues?q=is%3Aissue+sort%3Acreated-desc+) and this bug has not been reported yet.
17+
required: true
18+
- label: I have checked whether the bug also reproduces on the latest `main`.
19+
- type: textarea
20+
attributes:
21+
label: 🐛 Describe the bug
22+
description: A clear and concise description of what the bug is, and what you expected to happen instead.
23+
validations:
24+
required: true
25+
- type: textarea
26+
attributes:
27+
label: Reproducible code example
28+
description: |
29+
A minimal, self-contained script that we can copy and run to reproduce the bug. Please trim down any irrelevant code.
30+
Use synthetic or publicly available data, and include any required checkpoint name or revision.
31+
render: python
32+
placeholder: |
33+
# All necessary imports at the beginning
34+
import torch
35+
import sdm
36+
37+
# A succinct reproducing example trimmed down to the essential parts:
38+
...
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Error message or observed output
44+
description: The **full** traceback of the exception, or the output that shows the incorrect behavior.
45+
render: text
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: Versions
51+
description: |
52+
Your structured-data-models version or Git commit, how you installed it (e.g. pip, editable source checkout, or container image and tag), and the output of `python -m torch.utils.collect_env`.
53+
render: text
54+
validations:
55+
required: true
56+
- type: markdown
57+
attributes:
58+
value: |
59+
Thanks for contributing 🎉!

0 commit comments

Comments
 (0)