Skip to content

Commit 131da55

Browse files
committed
[General] Add issue templates
Signed-off-by: Seth Howell <sethh@nvidia.com>
1 parent df28141 commit 131da55

File tree

4 files changed

+114
-0
lines changed

4 files changed

+114
-0
lines changed

.github/ISSUE_TEMPLATE/ISSUE.yaml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
name: NVSHMEM issue or bug
2+
description: Report an issue or failure when running NVSHMEM code
3+
title: "[Issue]: "
4+
labels: ["triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reaching out! Before reporting a new issue, please feel free to search for the behavior in the existing issues. If you found an issue which is already closed or you are unsure, open a new issue and reference the old one from it.
11+
You can also check out the [FAQ section](https://docs.nvidia.com/nvshmem/api/faq.html) in our documentation.
12+
13+
---
14+
15+
To ensure we can assist you quickly and accurately, we often need the following information:
16+
- type: dropdown
17+
id: type
18+
attributes:
19+
label: How is this issue impacting you?
20+
description: What best describes your issue?
21+
options:
22+
- Lower performance than expected
23+
- Application crash
24+
- Data corruption
25+
- Application hang
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: log
31+
attributes:
32+
label: Share Your Debug Logs
33+
description: |
34+
35+
The logs are a great tool to pin down issues. Please set these environment variables before the run.
36+
* `NVSHMEM_DEBUG=INFO` and `NVSHMEM_DEBUG_SUBSYS=ALL` to produce full debug information.
37+
Please configure your launch script to capture one log per rank.
38+
39+
- type: textarea
40+
id: repro
41+
attributes:
42+
label: Steps to Reproduce the Issue
43+
description: |
44+
* **Minimal Steps**: Please provide a simple way to recreate the issue (see [Minimal Bug Reports](https://matthewrocklin.com/minimal-bug-reports) for inspiration).
45+
* **Environment Details**: Include software versions and relevant settings.
46+
* **Intermittency**: Is this a sporadic issue? If so, how often does it occur?
47+
* **Previous Success**: Did this work with an older NVSHMEM version?
48+
49+
The easier we can reproduce on our side the more likely we are to be able to solve it in a timely manner.
50+
51+
- type: input
52+
id: nvshmem_version
53+
attributes:
54+
label: NVSHMEM Version
55+
description: |
56+
NVSHMEM reports its version string in the debug logs.
57+
placeholder: "e.g. 3.4.5-0+cuda12.8"
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
id: platform
63+
attributes:
64+
label: Your platform details
65+
description: |
66+
* **GPU & Network**: Share your architecture and topology (e.g., from `nvidia-smi`, `nvidia-smi topo -m`, `ibstatus`).
67+
* **Environment**: Bare-metal, containers, or cloud?
68+
* **Scalability**: Does this issue occur with a specific number of ranks/nodes?
69+
70+
- type: textarea
71+
id: issue-description
72+
attributes:
73+
label: Error Message & Behavior
74+
description: |
75+
* **First Error**: What was the initial Error message in your logs?
76+
* **Expected vs. Actual**: Briefly describe the anticipated behavior versus what you're seeing.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: NVSHMEM question
2+
description: Ask the NVSHMEM team a question
3+
title: "[Question]: "
4+
labels: ["question"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thanks for reaching out! To solve your problem, feel free to check out the [user guide](https://docs.nvidia.com/nvshmem/api/using.html), in particular the FAQ section, and the [release notes](https://docs.nvidia.com/nvshmem/release-notes-install-guide/release-notes/index.html).
11+
---
12+
- type: textarea
13+
id: question
14+
attributes:
15+
label: Question

.github/ISSUE_TEMPLATE/RFE.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: NVSHMEM request for enhancement
2+
description: Request for enhancement
3+
title: "[RFE]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
10+
Thanks for your feedback! Before reporting a new RFE you could quickly check if this already exists in our [existing requests](https://github.com/NVIDIA/nvshmem/issues?q=is%3Aissue%20state%3Aopen%20label%3Aenhancement).
11+
12+
---
13+
- type: textarea
14+
id: rfe-description
15+
attributes:
16+
label: Please provide the below details to ensure we understand your needs
17+
description: |
18+
* What is the goal of this request?
19+
* Who will benefit from this feature?
20+
* Is this request for a specific GPU architecture or network infrastructure?
21+
* How will this feature improve current workflows or processes?
22+
* What is the priority level of this request?

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)