Skip to content
This repository has been archived by the owner on Dec 10, 2024. It is now read-only.

Commit

Permalink
chore: add form-based issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
fabianbormann committed Jan 17, 2024
1 parent 6229616 commit 1891ae8
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 19 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 🐞 Bug
description: Report a bug encountered while using this project
title: "[🐞 Bug]: <Brief Description of the Issue>"
labels: ["bug"]

body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current (incorrect 🙈) Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior (what you should have seen 🎉)
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the behavior.
placeholder: |
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
examples:
- **OS**: Ubuntu 23.10
- **Java JDK**: OpenJDK Runtime Environment (build 18.0.2.1+1-1)
value: |
- OS:
- Java JDK:
render: markdown
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: 🚀 Feature request
description: Suggest a new feature
title: "[🚀 Feature]: <Brief Description of the Feature>"
labels: feature

body:
- type: textarea
attributes:
label: 🚀 The feature and your motivation
description: >
A clear and concise description of your motivation for suggesting this feature.
validations:
required: true
- type: textarea
attributes:
label: Alternatives
description: >
Any alternative solutions, links to other feature requests or discussions.
- type: textarea
attributes:
label: Additional context
description: >
Add any other context about the feature request here.
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!!
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/task.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: 👷‍ Task
description: It's not a bug, it's not a feature, it's just something that needs to be done.
title: "[👷 Task]: <Brief Description of the task>"
labels: ["task"]

body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists covering this task.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Task description 🔨🔧
description: Describe the task in as much detail as you can. Provide a quick implementation instruction if possible.
validations:
required: true
- type: textarea
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the task?
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
19 changes: 0 additions & 19 deletions .github/PULL_REQUEST_TEMPLATE.md

This file was deleted.

0 comments on commit 1891ae8

Please sign in to comment.