Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added YAML templates of bug reports and feature requests #34

Merged
merged 8 commits into from
Aug 18, 2022
34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Report a bug
description: \U0001F41B Form to report bugs in the FEGA onboarding materials
title: "[BUG]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
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
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 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/)
2. Observe a typo in the first paragraph of 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
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/request_change.md

This file was deleted.

52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/request_change.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Feature request
description: \U0001F680 Form to create a request for changes.
title: "[FEATURE]: "
labels: ["feature"]
body:
- type: markdown
attributes:
value: |
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
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
M-casado marked this conversation as resolved.
Show resolved Hide resolved
- Content addition
- 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. I would like to request a new section 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