From 69f4ce7831a01e00de71b8e2887508c0bc3e30d5 Mon Sep 17 00:00:00 2001 From: Debbie Paul Date: Fri, 21 Jul 2023 15:44:29 -0500 Subject: [PATCH 1/3] adding bug.yml Will need review please. Example: will we have "version" information on TaxonPages? (If not, then this section needs to be removed). Example: how do people say which website / which page they are on where the issue occurs? (Do we ask for a URL)? --- .github/ISSUE_TEMPLATE/bug.yml | 77 ++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.yml diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..15edc8c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,77 @@ +name: Bug +description: Open a new issue to describe a bug. +title: "[Bug]: " +labels: ["bug"] +body: +- type: markdown + attributes: + value: > + Please describe the details of any bug you have found. Developers need to know specific details of what you found, where, and how this different from what you expect. _Need help filling this out? Once you have your feature details in hand, contact us and we'll help step you through filling out this issue._ +- type: markdown + attributes: + value: | + # Describe the bug + _Please provide a summary about the bug in the following form._ +- type: textarea + id: repro + attributes: + label: Steps to reproduce the bug + description: "How do you trigger this bug? Please walk us through it step by step. Try something like, When I do x, then I do y, and do z, I see this error" + value: | + 1. + 2. + 3. + ... + render: bash + validations: + required: true +- type: textarea + id: bug_screenshot + attributes: + label: Screenshot + description: Drag/drop your image/s here + validations: + required: false +- type: textarea + id: expected_behavior + attributes: + label: Expected behavior + description: Describe briefly what you expect to happen. + placeholder: When I do a, I expect b, c, d + validations: + required: false +- type: textarea + id: extra_screenshots + attributes: + label: Additional Screenshots + description: If applicable, add screenshots to help explain your problem. Drag/drop your image/s here + validations: + required: false +- type: dropdown + id: environment + validations: + required: true + attributes: + label: Environment + description: Please identify where you experience this bug. Please select all that apply. + multiple: true + options: + - TaxonPages +- type: input + id: taxonpages_site + attributes: + label: TaxonPages Site + description: Which website has this bug, please name it here + placeholder: Plecoptera, Orthoptera, Chrysididae, etc +- type: input + id: version + attributes: + label: Version + description: What is the version the bug happened on + placeholder: build ff302f1bc or v0.21.3 +- type: input + id: browser_used + attributes: + label: Browser Used + description: Please share the browser and its version you were using. + placeholder: (e.g. chrome, firefox) \ No newline at end of file From 3e3f67364a0e8e85d81205b8276e7d8ac11b0df7 Mon Sep 17 00:00:00 2001 From: Debbie Paul Date: Sun, 23 Jul 2023 19:01:15 -0500 Subject: [PATCH 2/3] Update bug.yml editing bug.yml with the edits requested by @mjy --- .github/ISSUE_TEMPLATE/bug.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 15edc8c..1fe5d21 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -60,18 +60,18 @@ body: - type: input id: taxonpages_site attributes: - label: TaxonPages Site - description: Which website has this bug, please name it here - placeholder: Plecoptera, Orthoptera, Chrysididae, etc + label: TaxonPages Site URL + description: Which website has this bug, please put the URL here + placeholder: https://orthoptera.speciesfile.org/ - type: input - id: version + id: taxonpages_panel attributes: - label: Version - description: What is the version the bug happened on - placeholder: build ff302f1bc or v0.21.3 + label: TaxonPages Panel + description: (optional) Provide which TaxonPages Panel has this bug + placeholder: Nomenclature, Map, Literature - type: input id: browser_used attributes: label: Browser Used description: Please share the browser and its version you were using. - placeholder: (e.g. chrome, firefox) \ No newline at end of file + placeholder: (e.g. chrome, firefox) From 9e7957c6dcfd3cb5a7a2834801a64c30f885a975 Mon Sep 17 00:00:00 2001 From: Debbie Paul Date: Sun, 23 Jul 2023 19:08:50 -0500 Subject: [PATCH 3/3] Update bug.yml removed "environment" section added note to URL section to ask people to put "local" if they are using TaxonPages in a development environment (i. e. where asking for URL doesn't make sense). --- .github/ISSUE_TEMPLATE/bug.yml | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 1fe5d21..a9bc3b1 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -47,22 +47,12 @@ body: description: If applicable, add screenshots to help explain your problem. Drag/drop your image/s here validations: required: false -- type: dropdown - id: environment - validations: - required: true - attributes: - label: Environment - description: Please identify where you experience this bug. Please select all that apply. - multiple: true - options: - - TaxonPages - type: input id: taxonpages_site attributes: label: TaxonPages Site URL - description: Which website has this bug, please put the URL here - placeholder: https://orthoptera.speciesfile.org/ + description: Which website has this bug, please put the URL here, use "local for development environments + placeholder: https://orthoptera.speciesfile.org/, local - type: input id: taxonpages_panel attributes: