From 878315775204975714cda2786cfd492160aea469 Mon Sep 17 00:00:00 2001 From: Romein van Buren Date: Tue, 30 May 2023 20:21:58 +0200 Subject: [PATCH] Added bug and PR templates --- .github/issue_template/bug.yml | 61 ++++++++++++++++++++++++++++++ .github/issue_template/docs.yml | 32 ++++++++++++++++ .github/issue_template/feature.yml | 37 ++++++++++++++++++ .github/pull_request_template.md | 7 ++++ 4 files changed, 137 insertions(+) create mode 100644 .github/issue_template/bug.yml create mode 100644 .github/issue_template/docs.yml create mode 100644 .github/issue_template/feature.yml create mode 100644 .github/pull_request_template.md diff --git a/.github/issue_template/bug.yml b/.github/issue_template/bug.yml new file mode 100644 index 0000000..ce9554f --- /dev/null +++ b/.github/issue_template/bug.yml @@ -0,0 +1,61 @@ +name: Bug report +description: Use this to report something that is not working properly. +labels: [bug] +assignees: [garraflavatra] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + - type: textarea + id: description + attributes: + label: Bug description + description: Give a brief description of the bug. What feature is broken? + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction + description: Include a reproduction if applicable. What did you do before the bug appeared? + validations: + required: true + + - type: input + id: version + attributes: + label: Version + description: What version of Rolens are you running? + validations: + required: true + + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + render: shell + + - type: textarea + id: environment + attributes: + label: Environment information + description: Please open Rolens and select _Rolens > Open log directory_. Open the `environment.json` file and paste its contents here. + render: shell + validations: + required: true + + - type: dropdown + id: severity + attributes: + label: Severity of this bug + options: + - Annoying + - Blocking a specific feature + - Blocking all usage + validations: + required: true diff --git a/.github/issue_template/docs.yml b/.github/issue_template/docs.yml new file mode 100644 index 0000000..7fdde2c --- /dev/null +++ b/.github/issue_template/docs.yml @@ -0,0 +1,32 @@ +name: Documentation issue +description: Report documentation issues here. +labels: [documentation] +assignees: [garraflavatra] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this report! + + - type: textarea + id: source + attributes: + label: Source + description: Which part of the documentation is erroneous? A link would be very nice! + validations: + required: true + + - type: textarea + id: problem + attributes: + label: Problem + description: Why is it wrong? + validations: + required: true + + - type: input + id: solution + attributes: + label: Solution + description: What should the documentation say instead? diff --git a/.github/issue_template/feature.yml b/.github/issue_template/feature.yml new file mode 100644 index 0000000..513b087 --- /dev/null +++ b/.github/issue_template/feature.yml @@ -0,0 +1,37 @@ +name: Feature request +description: Do you have an idea that could extend Rolens's possibilities? This is the place to propose it. +labels: [enhancement] +assignees: [garraflavatra] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to propose a new feature! + + - type: textarea + id: description + attributes: + label: Feature description + description: Give a brief description of the feature you'd like to see. What issue does it solve, and what is it capable of? + validations: + required: true + + - type: input + id: version + attributes: + label: Version + description: What version of Rolens are you running? + validations: + required: true + + - type: dropdown + id: importance + attributes: + label: Importance + options: + - Nice to have + - It would make Rolens more complete + - I cannot use Rolens without it + validations: + required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..63a51af --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ + + +...