From beeb1580a8c427203022f7299c8465fb860f7c61 Mon Sep 17 00:00:00 2001 From: "Kay Jan W." Date: Fri, 23 Aug 2024 14:06:06 +0800 Subject: [PATCH 1/3] Enhance issue template --- .github/ISSUE_TEMPLATE/bug_report.md | 33 ----------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 39 +++++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 33 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 65c67ba9..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the issue** -A clear and concise description of what the bug is. - -**Environment** -Describe your environment. - - Platform: [Windows / MacOS / Ubuntu] - - Python version: - - `bigtree` version: - -**To Reproduce** -Steps or code to reproduce the behaviour: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behaviour** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..c310b5b6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,39 @@ +name: Bug report +description: Create a report to help us improve +labels: ["bug"] +body: + - type: textarea + attributes: + label: Describe the issue + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + attributes: + label: Environment + description: Describe your environment. + placeholder: > + - Platform: [Windows / MacOS / Ubuntu] + - Python version: + - `bigtree` version: + - type: textarea + attributes: + label: To Reproduce + description: Steps or code to reproduce the behaviour. + placeholder: > + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + - type: textarea + attributes: + label: Expected behaviour + description: A clear and concise description of what you expected to happen. + - type: textarea + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + - type: textarea + attributes: + label: Expected behaviour + description: Add any other context about the problem here. From 50df9ec5ab0c92bda893ef9ade40cc17d01a6727 Mon Sep 17 00:00:00 2001 From: "Kay Jan W." Date: Fri, 23 Aug 2024 14:08:26 +0800 Subject: [PATCH 2/3] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c310b5b6..a4027650 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,5 +35,5 @@ body: description: If applicable, add screenshots to help explain your problem. - type: textarea attributes: - label: Expected behaviour + label: Additional context description: Add any other context about the problem here. From 1ccd22f543bcd3c73ac9953ba285f3204f21a674 Mon Sep 17 00:00:00 2001 From: "Kay Jan W." Date: Fri, 23 Aug 2024 14:10:33 +0800 Subject: [PATCH 3/3] Update bug_report.yml --- .github/ISSUE_TEMPLATE/bug_report.yml | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a4027650..3948f0b0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -12,23 +12,29 @@ body: attributes: label: Environment description: Describe your environment. - placeholder: > + placeholder: | - Platform: [Windows / MacOS / Ubuntu] - Python version: - - `bigtree` version: + - `bigtree` version: + validations: + required: true - type: textarea attributes: label: To Reproduce description: Steps or code to reproduce the behaviour. - placeholder: > + placeholder: | 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error + validations: + required: true - type: textarea attributes: label: Expected behaviour description: A clear and concise description of what you expected to happen. + validations: + required: true - type: textarea attributes: label: Screenshots