diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..724243a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..7d42a52 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: nvrs documentation + url: https://nvrs.adamperkowski.dev + about: check out the docs diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..649137e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -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