From 52b4fea311a37df3cd81db94ce7ce6330dae2d18 Mon Sep 17 00:00:00 2001 From: jlpereira Date: Mon, 28 Aug 2023 16:24:49 -0300 Subject: [PATCH] Add github templates --- .github/ISSUE_TEMPLATE/bug.yml | 67 ++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.yml | 36 ++++++++++++++++ 2 files changed, 103 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.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..a9bc3b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,67 @@ +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: input + id: taxonpages_site + attributes: + label: TaxonPages Site URL + 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: + 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) diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..552352b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,36 @@ +name: Feature request or enhancement +description: Open a new issue to describe and request a new feature or enhancement. These will be auto-labeled with _enhancement_. Be sure to provide an informative title. +labels: ["enhancement"] +body: +- type: textarea + id: summary + attributes: + label: Feature or enhancement + description: Please describe what you would like to be able to do or see. Consider telling a story, e.g. first I do x, then y, then I see z. + placeholder: E.g. When I am at X, then I need Y, and when I click, then I will see Z. + validations: + required: true +- type: input + id: summary_target + attributes: + label: Location + description: Stepping back, where should this feature be found? Providing a URL path can help (e.g. /taxon_names/123). + placeholder: Nomenclature Panel + validations: + required: true +- type: textarea + id: figures + attributes: + label: Screenshot, napkin sketch of interface, or conceptual description + description: Provide drawings or screenshots mocking-up (illustrating) your feature, or feature progression. + placeholder: Drag/drop your image(s) here + validations: + required: false +- type: input + id: summary_x + attributes: + label: Your role + description: Who are you, i.e. in what role are you making this feature request? + placeholder: Graduate student biologist + validations: + required: false