From 1a6e210a01a54b7095b414a64c1c6cc3810d8db4 Mon Sep 17 00:00:00 2001 From: Luka van der Plas Date: Tue, 31 Oct 2023 15:10:47 +0100 Subject: [PATCH] change bug report template to form --- .github/ISSUE_TEMPLATE/bug_report.md | 36 -------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 66 ++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 36 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5a8565682..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Let us know about something that isn't working right -title: '' -labels: bug -assignees: '' - ---- - -### What went wrong? - -Describe what happened. - -### Expected behavior - -What did you expect to happen? - -### Screenshots - -If applicable, please add a screenshot of the problem! - -### Which version? - -Please specify where you encountered the issue: - -- [ ] https://ianalyzer.hum.uu.nl -- [ ] https://peopleandparliament.hum.uu.nl -- [ ] https://peace.sites.uu.nl/ -- [ ] a server hosted elsewhere (i.e. not by the research software lab) -- [ ] a local server - -If this happened on local or third-party server, it helps if you can be more specific about the version. Please include the version number (e.g. "3.2.4") or a commit hash if you know it! - -### To reproduce - -How can a developer replicate the issue? Please provide any information you can. For example: "I went to https://ianalyzer.hum.uu.nl/search/troonredes?date=1814-01-01:1972-01-01 and then clicked on *Download CSV*. I pressed *cancel* and then I clicked *Download CSV* again." diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 000000000..82fed0b25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,66 @@ +--- +name: Bug report +description: Let us know that something isn't working right +labels: + - bug +body: + - type: markdown + attributes: + value: | + Thank you for making a bug report! Please fill in this information so we can get to the + bottom of your issue. + - type: textarea + id: what-happened + attributes: + label: What went wrong? + description: Please describe what happened. + validations: + required: true + - type: textarea + id: expected + attributes: + label: What did you expect to happen? + validations: + required: true + - type: textarea + id: screenshot + attributes: + label: Screenshot + description: If you can make a screenshot of the issue, please include it! + validations: + required: false + - type: checkboxes + id: instance + attributes: + label: Where did you find the bug? + description: Please add where you found the bug. + options: + - label: https://ianalyzer.hum.uu.nl + - label: https://peopleandparliament.hum.uu.nl + - label: https://peace.sites.uu.nl + - label: a server hosted elsewhere (i.e. not by the research software lab) + - label: a local server + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: | + For third-party and local servers, please add information about the version of the + software, if you know it. A version number (e.g "1.2.3") is great. For a pre-release + build, you can provide the branch or commit hash. + validations: + required: false + - type: textarea + id: to-reproduce + attributes: + label: Steps to reproduce + description: | + How can a developer replicate the issue? Please provide any information you can. For + example: "I went to + https://ianalyzer.hum.uu.nl/search/troonredes?date=1814-01-01:1972-01-01 and then + clicked on Download CSV. I pressed cancel and then I clicked Download CSV again." + validations: + required: true +---