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

Improve GitHub Issues templates #448

Merged
merged 1 commit into from
Oct 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug report
description: Create a report to help us improve
title: "Bug appears"
labels: ["Bug"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please check [existing issues](https://github.com/FAIRDataTeam/FAIRDataPoint/issues) to avoid duplication.
- type: dropdown
id: browser
attributes:
label: What components are related to the issue?
multiple: true
options:
- Metadata Records
- Metadata Schemas
- Resource Definitions
- Users and Permissions
- Settings
- Search
- API
- FDP Index
- Other (specify in text)
- type: dropdown
id: relation
attributes:
label: Which FDP are you using?
description: Select all that apply if you tried more.
multiple: true
options:
- My local instance
- FDP managed by someone else
- FDP that I manage
- type: textarea
id: version
attributes:
label: Version
description: Specify the version of FDP you are using (check "About" dialog in web UI)
render: plain text
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: What steps you took? Also tell us, what did you expect to happen? Please add any relevant screenshots (but avoid sharing personal or sensitive information).
placeholder: Tell us what you see!
value: "A bug happened!"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output, e.g. from docker-compose logs (but avoid sharing personal or sensitive information). This will be automatically formatted into code, so no need for backticks.
render: plain text

11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: FDP Documentation
url: https://fairdatapoint.readthedocs.io/
about: Please check FDP Documentation before reporting an issue, especially if you have an issue with your custom deployment.
- name: FDP Specification
url: https://specs.fairdatapoint.org/
about: Please check FDP Specification first, if you have any question related to the architecture or how things work in FDP.
- name: FDP Specification Issues
url: https://github.com/fdp-specs/fdp-specs.github.io/issues
about: Please create new issues related to FDP Specification in its dedicated GitHub repository.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Feature Request
description: Propose a new feature that would improve FDP
title: "New feature"
labels: ["Feature Request"]
assignees: []
body:
- type: markdown
attributes:
value: |
Please check [previous questions](https://github.com/FAIRDataTeam/FAIRDataPoint/issues?q=is%3Aissue+label%3AFeature%20Request+) first if you cannot already find an answer there.
- type: textarea
id: question
attributes:
label: Is your feature request related to a problem?
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when...
validations:
required: true
- type: textarea
id: question
attributes:
label: What solution you'd like?
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: question
attributes:
label: What alternatives have you considered?
description: A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: question
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Question
description: Ask anything that is unclear
title: "... ?"
labels: ["Question"]
assignees: []
body:
- type: markdown
attributes:
value: |
Please check [previous questions](https://github.com/FAIRDataTeam/FAIRDataPoint/issues?q=is%3Aissue+label%3AQuestion+) first if you cannot already find an answer there.
- type: textarea
id: question
attributes:
label: What is your question?
description: Ask what you want to know... please formulate your question clearly so also others may check it later.
validations:
required: true
Loading