From f46d786148c5d9b93f300e969feb817c58fb5b83 Mon Sep 17 00:00:00 2001 From: Daan Date: Sun, 7 Jan 2024 11:37:43 +0100 Subject: [PATCH 1/2] Add issue templates for bug reports and feature requests --- .github/ISSUE_TEMPLATE/bug.yml | 29 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + .github/ISSUE_TEMPLATE/feature.yml | 24 ++++++++++++++++++++++++ 3 files changed, 54 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..9cebf2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,29 @@ +name: Bug report +description: Form to report a bug +labels: ["bug"] +projects: [] +body: + - type: textarea + id: info + attributes: + label: Description + description: General description + validations: + required: false + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this environment... + 1. With this config... + 1. Run '...' + 1. See error... + 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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..889a7fc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,24 @@ +name: Feature request +description: Form to request a feature +labels: ["enhancement"] +projects: [] +body: + - type: textarea + id: story + attributes: + label: User story + description: Stick to the suggested form please! + value: | + **As a** + **When** + **I want** + **So that** + validations: + required: true + - type: textarea + id: info + attributes: + label: More info + description: Any additional information that might be useful + validations: + required: false From d173cd85e8ff1026b67bf31bc3bccbdb561a32db Mon Sep 17 00:00:00 2001 From: Daan Date: Sun, 7 Jan 2024 11:49:37 +0100 Subject: [PATCH 2/2] Add general instructions to issue templates --- .github/ISSUE_TEMPLATE/bug.yml | 4 ++++ .github/ISSUE_TEMPLATE/feature.yml | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 9cebf2c..26e4c3f 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -3,6 +3,10 @@ description: Form to report a bug labels: ["bug"] projects: [] body: + - type: markdown + attributes: + value: | + This form is for reporting any situation where a feature is not working as expected. - type: textarea id: info attributes: diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 889a7fc..885cd18 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -3,6 +3,10 @@ description: Form to request a feature labels: ["enhancement"] projects: [] body: + - type: markdown + attributes: + value: | + This form is for requesting any functional change of the software. Features can sometimes be for the developers only, such as adding tests or renaming things. In that case, start with 'as a developer, I want ..'. - type: textarea id: story attributes: