Skip to content

Commit

Permalink
docs(issue_template): add templates
Browse files Browse the repository at this point in the history
this adds issue templates for bug reports and feature requests, as well as the template configurarion file

Co-authored-by: Adam Perkowski <[email protected]>
Signed-off-by: Adam Perkowski <[email protected]>
  • Loading branch information
kurosakishigure and adamperkowski committed Jan 6, 2025
1 parent b61129d commit 7a5e9c7
Show file tree
Hide file tree
Showing 3 changed files with 165 additions and 0 deletions.
92 changes: 92 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
name: bug report
description: report a bug to help us improve
labels: ['bug']
body:
- type: markdown
attributes:
value: |
fill out the sections below to help us diagnose and fix the issue
- type: textarea
id: summary
attributes:
label: summary
description: a clear description of what went wrong
validations:
required: true

- type: textarea
id: to_reproduce
attributes:
label: to reproduce
description: list all steps required to reproduce the behavior
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: expected behavior
description: what did you expect to happen
validations:
required: true

- type: textarea
id: actual_behavior
attributes:
label: actual behavior
description: detailed description of what actually happened
validations:
required: true

- type: textarea
id: additional
attributes:
label: additional context
description: add any other context, screenshots, or logs to help us debug the issue
validations:
required: false

- type: dropdown
id: severity
attributes:
label: severity
description: the level of importance
options:
- low
- medium
- high
- critical
validations:
required: true

- type: dropdown
id: os
attributes:
label: OS
description: the operating system where the bug occurred
multiple: true
options:
- Linux
- MacOS
- Windows
- Other
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: checklist
description: check all that apply
options:
- label: 'i have checked the documentation'
required: true
- label: 'i have read the Code of Conduct'
required: true
- label: 'this is NOT a secutity vulnerability (refer to SECUTITY.md)'
required: true
- label: 'there are no known workarounds'
required: false
- label: 'there are no already existing issues or pull requests for this bug'
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: nvrs documentation
url: https://nvrs.adamperkowski.dev
about: check out the docs
68 changes: 68 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: feature request
description: request a new feature for nvrs
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
fill out the sections below to help us understand your request
- type: textarea
id: summary
attributes:
label: summary
description: a clear description of the feature
validations:
required: true

- type: textarea
id: problem
attributes:
label: the problem
description: is this request related to a problem? please describe
validations:
required: false

- type: textarea
id: usecase
attributes:
label: use case
description: describe the use case for this feature
validations:
required: false

- type: textarea
id: additional
attributes:
label: additional context
description: add any other context or information avout this feature
validations:
required: false

- type: dropdown
id: severity
attributes:
label: importance
description: the level of importance
options:
- low
- medium
- high
- critical
validations:
required: true

- type: checkboxes
id: checklist
attributes:
label: checklist
description: check all that apply
options:
- label: 'i have checked the documentation'
required: true
- label: 'i have read the Code of Conduct'
required: true
- label: 'there are no known workarounds'
required: false
- label: 'there are no already existing issues or pull requests for this feature'
required: true

0 comments on commit 7a5e9c7

Please sign in to comment.