Repository: ai-dynamo/dynamo
Pull request #471: chore: Add default issue template for bug & feature requests
Author: login: nv-tusharma
Created: 2025-04-01T18:13:56Z | Merged: 2025-04-01T21:27:07Z

#### Overview:

<!-- Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.-->

Add a default github issue template for bug & feature requests for customers to use when filing bugs/features issues. Add a config.yml which provides the user with default information for support including the documentation & link to Discord for community support. To visualize the changes, navigate to: https://github.com/ai-dynamo/dynamo/tree/tusharma/add-github-issues-template/.github/ISSUE_TEMPLATE

#### Details:

- ``bug_report.yml`` : Add a default template for bug reports filed against the dynamo repository. 
- ``feature_request.yml``: Add a default template for feature requests filed against the dynamo repository. 
- ``config.yml``: Create a template chooser which provides users default information when creating issues. 





Diff:
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000000..56ea41e75159
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,80 @@
+name: Bug Report
+description: Submit a bug report to help improve ai-dynamo
+title: "[BUG]: <Enter bug title>"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report to improve ai-dynamo!
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How can we reproduce this issue?
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: Please provide details about your environment.
+      placeholder: |
+        Operating System (Required): e.g. Ubuntu 24.04
+        ai-dynamo Version (Required): e.g. 0.1.0 or git commit SHA if you cloned the repo
+        ai-dynamo-runtime Version (Required): e.g. 0.1.0
+        ai-dynamo-vllm Version (Required): e.g. 0.7.2
+        nixl Version (Required): e.g. 0.1.0 or git commit SHA if you cloned the repo
+        CPU Architecture (Required): e.g. x86_64 (run `uname -m`)
+        CUDA Version (Required): e.g. 12.8 (run `nvidia-smi`)
+        GPU Architecture (Required): e.g. A100 (run `nvidia-smi -L`)
+        Python Version (Required): e.g. 3.12.3 (run `python --version`)
+        glibc Version (Optional): e.g. 2.39 (run `ldd --version`)
+        Docker Version (Optional): e.g. 28.0.2 (run `docker --version`)
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+    validations:
+      required: false
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+    validations:
+      required: false
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 000000000000..1418085d2f2a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Dynamo documentation
+    url: https://www.nvidia.com/en-us/ai/dynamo/
+    about: Refer to the Dynamo documentation to help you get started.
+  - name: Dynamo Community Support
+    url: https://discord.gg/dynamo
+    about: Refer to the Dynamo Discord server for community support.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
new file mode 100644
index 000000000000..26387dfac6ef
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -0,0 +1,30 @@
+name: Feature Request
+description: Suggest an improvement for ai-dynamo
+title: '[FEATURE]: <Enter feature title>'
+body:
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: Feature request
+      description: |
+        A clear and concise description of the feature proposal.
+    validations:
+      required: true
+
+  - type: textarea
+    id: problem
+    attributes:
+      label: Describe the problem you're encountering
+      description: |
+        Please describe the problem you're encountering. Include any relevant environment information (eg. os, dynamo version, etc).
+    validations:
+      required: true
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've tried
+      description: |
+        Please describe any alternative solutions you've tried in as much detail as possible.
+    validations:
+      required: false


Reviews:
user: login: saturley-hall
state: APPROVED
author_association: MEMBER
submitted_at: 2025-04-01T19:42:21Z
user: login: dmitry-tokarev-nv
state: CHANGES_REQUESTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-01T20:35:19Z
user: login: dmitry-tokarev-nv
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-04-01T21:12:58Z

Review comments:
diff_hunk: @@ -0,0 +1,147 @@
+name: Bug Report
+description: Submit a bug report to help improve ai-dynamo
+title: "[BUG]: <Enter bug title>"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report to improve ai-dynamo!
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How can we reproduce this issue?
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+        Please provide details about your environment.
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you using?
+      placeholder: e.g. Ubuntu 24.04
+    validations:
+      required: true
+
+  - type: input
+    id: dynamo-version
+    attributes:
+      label: ai-dynamo Version
+      description: What version of ai-dynamo are you using?
+      placeholder: e.g. 0.1.0
path: .github/ISSUE_TEMPLATE/bug_report.yml
user: login: dmitry-tokarev-nv
body: here can we add that version can be a commit SHA if the user git cloned dynamo repo?
created_at: 2025-04-01T20:30:19Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,147 @@
+name: Bug Report
+description: Submit a bug report to help improve ai-dynamo
+title: "[BUG]: <Enter bug title>"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report to improve ai-dynamo!
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How can we reproduce this issue?
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+        Please provide details about your environment.
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you using?
+      placeholder: e.g. Ubuntu 24.04
+    validations:
+      required: true
+
+  - type: input
+    id: dynamo-version
+    attributes:
+      label: ai-dynamo Version
+      description: What version of ai-dynamo are you using?
+      placeholder: e.g. 0.1.0
+    validations:
+      required: true
+
+  - type: input
+    id: dynamo-rt-version
+    attributes:
+      label: ai-dynamo-runtime Version
+      description: What version of ai-dynamo-runtime are you using?
+      placeholder: e.g. 0.1.0
+    validations:
+      required: false
+
+  - type: input
+    id: dynamo-vllm-version
+    attributes:
+      label: ai-dynamo-vllm Version
+      description: What version of ai-dynamo-vllm are you using?
+      placeholder: e.g. 0.7.2
+    validations:
+      required: false
+
+  - type: input
+    id: nixl-version
+    attributes:
+      label: nixl Version
+      description: What version of nixl are you using?
+      placeholder: e.g. 0.1.0
+    validations:
+      required: false
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: What version of Python are you using?
+      placeholder: e.g. 3.12.3
+    validations:
+      required: false
+
+  - type: input
+    id: cpu-type
+    attributes:
+      label: CPU Architecture
+      description: What CPU Architecture are you using? You can find this by running `uname -m` in your terminal.
+      placeholder: e.g. x86_64
+    validations:
+      required: false
+
+  - type: input
+    id: cuda-version
+    attributes:
+      label: CUDA Version
+      description: If applicable, what CUDA version are you using? You can find this by running `nvidia-smi` in your terminal and looking at the CUDA Version column.
+      placeholder: e.g. 12.8
+    validations:
+      required: false
+
+  - type: input
+    id: gpu-type
+    attributes:
+      label: GPU Architecture
+      description: If applicable, what GPU Architecture are you using? You can find this by running `nvidia-smi -L` in your terminal.
+      placeholder: e.g. A100
+    validations:
+      required: false
+
path: .github/ISSUE_TEMPLATE/bug_report.yml
user: login: dmitry-tokarev-nv
body: Can we add glibc version input question?
`ldd --version`
created_at: 2025-04-01T20:31:28Z
author_association: CONTRIBUTOR
diff_hunk: @@ -0,0 +1,147 @@
+name: Bug Report
+description: Submit a bug report to help improve ai-dynamo
+title: "[BUG]: <Enter bug title>"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report to improve ai-dynamo!
+
+  - type: textarea
+    id: bug-description
+    attributes:
+      label: Describe the Bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to Reproduce
+      description: How can we reproduce this issue?
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected Behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual Behavior
+      description: What actually happened?
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment
+        Please provide details about your environment.
+
+  - type: input
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you using?
+      placeholder: e.g. Ubuntu 24.04
+    validations:
+      required: true
+
+  - type: input
+    id: dynamo-version
+    attributes:
+      label: ai-dynamo Version
+      description: What version of ai-dynamo are you using?
+      placeholder: e.g. 0.1.0
+    validations:
+      required: true
+
+  - type: input
+    id: dynamo-rt-version
+    attributes:
+      label: ai-dynamo-runtime Version
+      description: What version of ai-dynamo-runtime are you using?
+      placeholder: e.g. 0.1.0
+    validations:
+      required: false
+
+  - type: input
+    id: dynamo-vllm-version
+    attributes:
+      label: ai-dynamo-vllm Version
+      description: What version of ai-dynamo-vllm are you using?
+      placeholder: e.g. 0.7.2
+    validations:
+      required: false
+
+  - type: input
+    id: nixl-version
+    attributes:
+      label: nixl Version
+      description: What version of nixl are you using?
+      placeholder: e.g. 0.1.0
+    validations:
+      required: false
+
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: What version of Python are you using?
+      placeholder: e.g. 3.12.3
+    validations:
+      required: false
+
+  - type: input
+    id: cpu-type
+    attributes:
+      label: CPU Architecture
+      description: What CPU Architecture are you using? You can find this by running `uname -m` in your terminal.
+      placeholder: e.g. x86_64
+    validations:
+      required: false
+
+  - type: input
+    id: cuda-version
+    attributes:
+      label: CUDA Version
+      description: If applicable, what CUDA version are you using? You can find this by running `nvidia-smi` in your terminal and looking at the CUDA Version column.
+      placeholder: e.g. 12.8
+    validations:
+      required: false
+
+  - type: input
+    id: gpu-type
+    attributes:
+      label: GPU Architecture
+      description: If applicable, what GPU Architecture are you using? You can find this by running `nvidia-smi -L` in your terminal.
+      placeholder: e.g. A100
+    validations:
+      required: false
+
path: .github/ISSUE_TEMPLATE/bug_report.yml
user: login: dmitry-tokarev-nv
body: Can we add optional docker version ?
there were several issues when users had trouble with docker. 
Overall we just want users to describe their environment with as much detail as possible.
created_at: 2025-04-01T20:35:00Z
author_association: CONTRIBUTOR

PR comments:
user: login: copy-pr-bot[bot]
created_at: 2025-04-01T18:14:00Z
body: This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities [here](https://docs.gha-runners.nvidia.com/cpr/vetters).

Contributors can view more details about this message [here](https://docs.gha-runners.nvidia.com/cpr/contributors).

author_association: NONE
user: login: dmitry-tokarev-nv
created_at: 2025-04-01T20:33:30Z
body: Thank you for adding this!
Can we combine input fields for OS, python, glibc, cpu arch, cuda, docker (if applicable), gpu model into a single field `environment` ?
author_association: CONTRIBUTOR