From 72ddae2a97cf0942dbf0bb092d6dd52f8fa74324 Mon Sep 17 00:00:00 2001 From: M-casado Date: Tue, 6 Dec 2022 13:14:47 +0000 Subject: [PATCH] EEH-2470 - Added PR and Bug Report issue templates --- .github/ISSUE_TEMPLATE/bug_report.yaml | 77 ++++++++++++++++++++++++++ .github/pull_request_template.md | 7 +++ 2 files changed, 84 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..e3be004 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,77 @@ +name: Report a bug +description: Form to report bugs. +title: "[BUG]: " +labels: ["bug"] +assignees: + - theisuru +body: + - type: markdown + attributes: + value: | + This form serves as a template for **reporting Biovalidator bugs** (e.g. malfunctioning validation, empty logs...). + - type: input + id: bug-title + attributes: + label: Bug summary + description: Please provide a summary or title for the bug. + placeholder: e.g. Validation crashes when compiling the schemas + validations: + required: true + - type: textarea + id: technical-details + attributes: + label: Technical details + description: If relevant, please specify the technical details of the environment in which Biovalidator was run + placeholder: | + e.g. + * Used GitHub branch: main + * Node version: v16.13.0 + * npm version: 8.6.0 + * Operating system: WSL2 + ... + validations: + required: false + - type: textarea + id: to-reproduce + attributes: + label: To reproduce + description: Please explain in detail what led you to observe the bug to help us reproduce it while we try to fix it. + placeholder: | + e.g. + Steps to reproduce: + 1. Clone project and install dependencies: + ```` + git clone https://github.com/elixir-europe/biovalidator.git + cd biovalidator + npm install + ```` + 2. Deploy the server: + ```` + node src/biovalidator + ```` + 3. ... + validations: + required: true + - type: textarea + id: observed-behaviour + attributes: + label: Observed behaviour + description: Please explain the behaviour you observed and considered a bug. + placeholder: e.g. When validating the document helloworld.json an error appeared specifying the schema could not be compiled. + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Expected behaviour + description: Please explain what you expected to happen if there was no bug. + placeholder: e.g. The schema should be compiled and the validation performed onto document helloworld.json + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Use this section to add any context that could aid in the fixing of the bug, including error messages, screenshots, used JSON schemas and documents... + validations: + required: false \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8ca86f0 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ +## Issue / Ticket reference + +## Overall changes +- + +## Future TO-DOs +- [ ]