From 5b87d102921d3dd03b4ca290bbe9418122cc1ae1 Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:21:32 +0100 Subject: [PATCH 1/8] Added YAML templates of bug reports and feature requests --- .github/ISSUE_TEMPLATE/bug_report.md | 34 -------------- .github/ISSUE_TEMPLATE/bug_report.yaml | 52 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/request_change.md | 23 ---------- .github/ISSUE_TEMPLATE/request_change.yaml | 51 +++++++++++++++++++++ 4 files changed, 103 insertions(+), 57 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yaml delete mode 100644 .github/ISSUE_TEMPLATE/request_change.md create mode 100644 .github/ISSUE_TEMPLATE/request_change.yaml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d671fbf..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: "\U0001F41B Bug report" -about: Create a report to help us fix an issue. -labels: bug ---- - -**Description** - - - - - -**To reproduce** - - - - - -**Observed behavior** - - - - - -**Expected behavior** - - - - - -**Screenshots** - - - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..1966782 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,52 @@ +name: Report a bug +description: \U0001F41B Form to report bugs of the FEGA onboarding repository +title: "[BUG]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + This form serves as a template for **reporting bugs of the FEGA onboarding repository** (e.g. wrong URLs, typos, missing information, etc.). For issues exclusively concerning Central EGA (e.g. download client, [ega-archive](https://ega-archive.org/) website, etc.) please contact ``helpdesk [at] ega-archive.org``. + Thank you for your support to the Federated European Genome-phenome Archive (FEGA)! + - type: input + id: bug-title + attributes: + label: Bug summary + description: Please provide a summary or title for the bug. + placeholder: e.g. Typo in the maturity model documentation + validations: + required: true + - type: textarea + id: to-reproduce + attributes: + label: To reproduce + description: Please explain in detail what lead you to observe the bug to help us reproduce it while we try to fix it. + placeholder: | + e.g. Steps to reproduce: + 1. Go to the maturity model documentation (https://ega-archive.github.io/FEGA-onboarding/topics/maturity-model/) + 2. Observe a typo in the ``Learn about the FEGA Maturity Model`` section + validations: + required: true + - type: textarea + id: observed-behaviour + attributes: + label: Observed behaviour + description: Please explain the behaviour you observed and considered a bug. Include any error messages or warnings you observed. + placeholder: e.g. The description says "Gobbernance" + 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 description says "Governance" + validations: + required: true + - type: textarea + id: additional-context + attributes: + label: Additional context + description: Use this section to add any context, including error messages or screenshots (if applicable), that could aid in the fixing of the bug. + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/request_change.md b/.github/ISSUE_TEMPLATE/request_change.md deleted file mode 100644 index 4bd5351..0000000 --- a/.github/ISSUE_TEMPLATE/request_change.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: "\U0001F680 Feature request" -about: Create a request for changes. -labels: requested-change ---- - -**Location** - - - - - -**Change** - - - - - -**Reason** - - - - diff --git a/.github/ISSUE_TEMPLATE/request_change.yaml b/.github/ISSUE_TEMPLATE/request_change.yaml new file mode 100644 index 0000000..8751356 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/request_change.yaml @@ -0,0 +1,51 @@ +name: Feature request +description: \U0001F680 Form to create a request for changes. +title: "[FEATURE]: " +labels: ["feature"] +body: + - type: markdown + attributes: + value: | + This form serves as a template to **create a request for changes**. It can be used, for example, to add a new section or functionality to the [FEGA-onboarding webspage](https://ega-archive.github.io/FEGA-onboarding/). + Thank you for contributing to the Federated European Genome-phenome Archive (FEGA)! + + - type: dropdown + id: feature-type + attributes: + label: Feature type(s) + description: What type(s) of feature are you requesting? Select as many categories as you see fit from the dropdown menu. + multiple: true + options: + - Content modification + - Website appearance + - GitHub repository + - Other/unsure + validations: + required: true + + - type: input + id: location + attributes: + label: Location + description: Please indicate the website URL or GitHub repository path where the requested change is located. + placeholder: e.g. https://ega-archive.github.io/FEGA-onboarding/topics/maturity-model/ + validations: + required: true + + - type: textarea + id: change-description + attributes: + label: Description of the change + description: Please describe the change you are requesting. Make it as detailed as possible. + placeholder: e.g. A new section should be added at... + validations: + required: true + + - type: textarea + id: change-reason + attributes: + label: Reason for the change + description: Please explain why the change is being requested and what value it adds. + placeholder: e.g. Having a section about ... would ease the learning pace of... + validations: + required: true \ No newline at end of file From 6fc400314fc8d8dd6f83ba6d787976a07b019b5e Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:44:49 +0100 Subject: [PATCH 2/8] Update .github/ISSUE_TEMPLATE/request_change.yaml Co-authored-by: Mallory Freeberg --- .github/ISSUE_TEMPLATE/request_change.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/request_change.yaml b/.github/ISSUE_TEMPLATE/request_change.yaml index 8751356..509d5f5 100644 --- a/.github/ISSUE_TEMPLATE/request_change.yaml +++ b/.github/ISSUE_TEMPLATE/request_change.yaml @@ -37,7 +37,7 @@ body: attributes: label: Description of the change description: Please describe the change you are requesting. Make it as detailed as possible. - placeholder: e.g. A new section should be added at... + placeholder: e.g. I would like to request a new section be added at... validations: required: true From 37541a23047b6b9c9f1374e09fa8707ae3125081 Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:44:59 +0100 Subject: [PATCH 3/8] Update .github/ISSUE_TEMPLATE/request_change.yaml Co-authored-by: Mallory Freeberg --- .github/ISSUE_TEMPLATE/request_change.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/request_change.yaml b/.github/ISSUE_TEMPLATE/request_change.yaml index 509d5f5..57de427 100644 --- a/.github/ISSUE_TEMPLATE/request_change.yaml +++ b/.github/ISSUE_TEMPLATE/request_change.yaml @@ -17,6 +17,7 @@ body: multiple: true options: - Content modification + - Content addition - Website appearance - GitHub repository - Other/unsure From 0fae68f30753f72b7113810cab582285b5dd9ae1 Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:45:10 +0100 Subject: [PATCH 4/8] Update .github/ISSUE_TEMPLATE/request_change.yaml Co-authored-by: Mallory Freeberg --- .github/ISSUE_TEMPLATE/request_change.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/request_change.yaml b/.github/ISSUE_TEMPLATE/request_change.yaml index 57de427..e6b3ed4 100644 --- a/.github/ISSUE_TEMPLATE/request_change.yaml +++ b/.github/ISSUE_TEMPLATE/request_change.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - This form serves as a template to **create a request for changes**. It can be used, for example, to add a new section or functionality to the [FEGA-onboarding webspage](https://ega-archive.github.io/FEGA-onboarding/). + This form is a template to **create a request for changes**. It can be used, for example, to add a new section or functionality to the [FEGA onboarding webpages](https://ega-archive.github.io/FEGA-onboarding/). Thank you for contributing to the Federated European Genome-phenome Archive (FEGA)! - type: dropdown From 4879b570ee9e9805a380a58bd9ac7313610ba92e Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:45:22 +0100 Subject: [PATCH 5/8] Update .github/ISSUE_TEMPLATE/bug_report.yaml Co-authored-by: Mallory Freeberg --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 1966782..418b235 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -24,7 +24,7 @@ body: placeholder: | e.g. Steps to reproduce: 1. Go to the maturity model documentation (https://ega-archive.github.io/FEGA-onboarding/topics/maturity-model/) - 2. Observe a typo in the ``Learn about the FEGA Maturity Model`` section + 2. Observe a typo in the first paragraph of the ``Learn about the FEGA Maturity Model`` section validations: required: true - type: textarea From f0ee857300141ab9fd1c0fa6168a991dd1235f8b Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:45:34 +0100 Subject: [PATCH 6/8] Update .github/ISSUE_TEMPLATE/bug_report.yaml Co-authored-by: Mallory Freeberg --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 418b235..30f509d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -20,7 +20,7 @@ body: id: to-reproduce attributes: label: To reproduce - description: Please explain in detail what lead you to observe the bug to help us reproduce it while we try to fix it. + 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. Go to the maturity model documentation (https://ega-archive.github.io/FEGA-onboarding/topics/maturity-model/) From 802f5351838f695e1099075bb621f6255d016bda Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:45:50 +0100 Subject: [PATCH 7/8] Update .github/ISSUE_TEMPLATE/bug_report.yaml Co-authored-by: Mallory Freeberg --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 30f509d..404c77a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - This form serves as a template for **reporting bugs of the FEGA onboarding repository** (e.g. wrong URLs, typos, missing information, etc.). For issues exclusively concerning Central EGA (e.g. download client, [ega-archive](https://ega-archive.org/) website, etc.) please contact ``helpdesk [at] ega-archive.org``. + This form is a template for **reporting bugs in the FEGA onboarding materials** (e.g. wrong URLs, typos, broken formatting). For issues concerning Central EGA (e.g. download client, [ega-archive](https://ega-archive.org/) website) please contact ``helpdesk [at] ega-archive.org``. Thank you for your support to the Federated European Genome-phenome Archive (FEGA)! - type: input id: bug-title From 4f020f1a88b3fd7cdb6143ad00b88cdfca50ab11 Mon Sep 17 00:00:00 2001 From: M-casado Date: Thu, 18 Aug 2022 14:45:54 +0100 Subject: [PATCH 8/8] Update .github/ISSUE_TEMPLATE/bug_report.yaml Co-authored-by: Mallory Freeberg --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 404c77a..5d783bd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -1,5 +1,5 @@ name: Report a bug -description: \U0001F41B Form to report bugs of the FEGA onboarding repository +description: \U0001F41B Form to report bugs in the FEGA onboarding materials title: "[BUG]: " labels: ["bug"] body: