use github forms for issue flow management, fixes #127

2022-05-19 10:23:55 +02:00 · 2022-05-19 10:23:55 +02:00 · b48f850670
commit b48f850670
parent d8f3bcff92
5 changed files with 159 additions and 45 deletions
--- a/.github/ISSUE_TEMPLATE/10_functional_bug.yml
+++ b/.github/ISSUE_TEMPLATE/10_functional_bug.yml
@ -0,0 +1,90 @@
+name: Report a functional bug 🐛
+description: Functional bugs affect operation or stability of the driver and/or hardware.
+body:
+- type: markdown
+  attributes:
+    value: |
+      Before filling out, please check if your issue has already been reported.
+      
+      Also, please pead [CONTRIBUTING.md](https://github.com/NVIDIA/open-gpu-kernel-modules/blob/main/CONTRIBUTING.md) for more details.
+      
+      Thank you!
+- type: input
+  id: sw_driver_version
+  attributes:
+    label: NVIDIA Open GPU Kernel Modules Version
+    description: "Which open-gpu-kernel-modules version are you running? Be as specific as possible: SHA is best when built from specific commit."
+  validations:
+    required: true
+- type: dropdown
+  id: sw_driver_proprietary
+  attributes:
+    label: "Does this happen with the proprietary driver (of the same version) as well?"
+    options:
+    - "Yes"
+    - "No"
+    - "I cannot test this"
+  validations:
+    required: true
+- type: input
+  id: sw_host_os
+  attributes:
+    label: Operating System and Version
+    description: "Which OS are you running this on? (output of `lsb_release -d`)"
+  validations:
+    required: true
+- type: input
+  id: sw_host_kernel
+  attributes:
+    label: Kernel Release
+    description: "Which kernel are you running? (output of `uname -a`, say if you built it yourself)"
+  validations:
+    required: true
+- type: input
+  id: hw_gpu_type
+  attributes:
+    label: "Hardware: GPU"
+    description: "Which GPU is this bug manifesting on? (output of `nvidia-smi -L`)"
+  validations:
+    required: true
+- type: textarea
+  id: bug_description
+  attributes:
+    label: "Describe the bug"
+    description: "Please write a clear and concise description of what the bug is."
+  validations:
+    required: true
+- type: textarea
+  id: bug_repro
+  attributes:
+    label: "To Reproduce"
+    description: "Please provide bullet-pointed reproduction steps, so we can see the issue on our end. Name all required preconditions."
+  validations:
+    required: true
+- type: dropdown
+  id: bug_incidence
+  attributes:
+    label: "Bug Incidence"
+    description: "How often does the issue happen?"
+    options:
+    - Once
+    - Sometimes
+    - Always
+  validations:
+    required: true
+- type: textarea
+  id: bug_report_gz
+  attributes:
+    label: nvidia-bug-report.log.gz
+    description: "Please reproduce the problem, after that run `nvidia-bug-report.sh`, and attach the resulting nvidia-bug-report.log.gz here."
+    placeholder: You can usually just drag & drop the file into this textbox.
+  validations:
+    required: true
+- type: textarea
+  id: bug_more_info
+  attributes:
+    label: "More Info"
+    description: "If unclear from the above: What else we need to know? What did you expect to happen but did not?"
+  validations:
+    required: false
+    
--- a/.github/ISSUE_TEMPLATE/20_build_bug.yml
+++ b/.github/ISSUE_TEMPLATE/20_build_bug.yml
@ -0,0 +1,55 @@
+name: Report a build bug 🛠
+description: Bugs related to the build system, compiler or OS support.
+body:
+- type: markdown
+  attributes:
+    value: |
+      Before filling out, please check if your issue has already been reported.
+      
+      Also, please pead [CONTRIBUTING.md](https://github.com/NVIDIA/open-gpu-kernel-modules/blob/main/CONTRIBUTING.md) for more details.
+      
+      Thank you!
+- type: input
+  id: sw_driver_version
+  attributes:
+    label: NVIDIA Open GPU Kernel Modules Version
+    description: "Which open-gpu-kernel-modules version are you running? Be as specific as possible: SHA is best when built from specific commit."
+  validations:
+    required: true
+- type: input
+  id: sw_host_os
+  attributes:
+    label: Operating System and Version
+    description: "Which OS are you running this on? (output of `lsb_release -d`)"
+  validations:
+    required: true
+- type: input
+  id: sw_host_kernel
+  attributes:
+    label: Kernel Release
+    description: "Which kernel are you running? (output of `uname -a`, say if you built it yourself)."
+  validations:
+    required: true
+- type: textarea
+  id: bug_description
+  attributes:
+    label: "Build Command"
+    description: "Please show what command(s) you ran that led to the issue."
+  validations:
+    required: true
+- type: textarea
+  id: bug_build_log
+  attributes:
+    label: Terminal output/Build Log
+    description: |
+      Please paste the build log here. You can wrap it into pairs of three backticks to blockquote it.
+  validations:
+    required: true
+- type: textarea
+  id: bug_more_info
+  attributes:
+    label: "More Info"
+    description: "If unclear from the above: What else we need to know? What did you expect to happen but did not?"
+  validations:
+    required: false
+    
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@ -1,25 +0,0 @@
---
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: ''
-
---
-
-**NVIDIA Driver Version**
-Please write the version of the NVIDIA driver you are using.
-
-**GPU**
-Please write the particular model of NVIDIA GPU you are using.
-
-**Describe the bug**
-Please write a clear and concise description of what the bug is.
-
-**To Reproduce**
-Please write the steps to reproduce the behavior.
-
-**Expected behavior**
-Please write a clear and concise description of what you expected to happen.
-
-**Please reproduce the problem, run nvidia-bug-report.sh, and attach the resulting nvidia-bug-report.log.gz.**
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Report a cosmetic issue
+    url: https://github.com/NVIDIA/open-gpu-kernel-modules/discussions/categories/general
+    about: We are not currently accepting cosmetic-only changes such as whitespace, typos, or simple renames. You can still discuss and collect them on the boards.
+  - name: Ask a question
+    url: https://github.com/NVIDIA/open-gpu-kernel-modules/discussions/categories/q-a
+    about: Unsure of what to click, where to go, what the process for your thing is? We're happy to help. Click to visit the discussion board and say hello!
+  - name: Report a bug with the proprietary driver
+    url: https://forums.developer.nvidia.com/c/gpu-graphics/linux/148
+    about: Bugs that aren't specific to the open source driver in this repository should be reported with the linked forums instead. If you are unsure on what kind of bug you have, feel free to open a thread in Discussions. We're here to help!
+  - name: Suggest a feature
+    url: https://github.com/NVIDIA/open-gpu-kernel-modules/discussions/categories/ideas
+    about: Please do not open Issues for feature requests; instead, suggest and discuss new features on the Github discussion board. If you have a feature you worked on and want to PR it, please also open a discussion before doing so.
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@ -1,20 +0,0 @@
---
-name: Feature request
-about: Suggest an idea for this project
-title: New Feature Request
-labels: enhancement
-assignees: ''
-
---
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.