Skip to content

Commit

Permalink
Updated issue templates (#4600)
Browse files Browse the repository at this point in the history
Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com>
  • Loading branch information
sreichel and kiatng authored Mar 2, 2025
1 parent ae258da commit 0f224a5
Show file tree
Hide file tree
Showing 6 changed files with 128 additions and 81 deletions.
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

57 changes: 57 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: 🐛 Bug report
description: File a bug/issue
title: "[BUG] <title>"
labels: ["bug", "review needed"]
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 Behavior
description: A concise description of what you're experiencing.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: true
- 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:
- **OpenMage**: 20.12.2
- **php**: 7.4
value: |
- OpenMage:
- php:
render: markdown
validations:
required: false
- 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
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/developer-experience-issue.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/developer-experience.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: 👀 Developer experience
description: Issues related to customization, extensibility, modularity
title: "<title>"
labels: ["review needed"]
body:
- type: textarea
attributes:
label: Summary
description: Describe the issue you are experiencing. Include general information, error messages, environments, and so on.
validations:
required: true
- type: textarea
attributes:
label: Examples
description: Provide code examples or a patch with a test (recommended) to clearly indicate the problem.
validations:
required: true
- type: textarea
attributes:
label: Proposed solution
description: Suggest your potential solutions for this issue.
validations:
required: false
- 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
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: 🚀 Feature request
description: Suggest an idea or feature request
title: "[FEAT] <title>"
labels: ["new feature", "review needed"]
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: Description
description: Describe the feature you would like to add.
validations:
required: true
- type: textarea
attributes:
label: Expected Behavior
description: What is the expected behavior of this feature? How is it going to work?
validations:
required: true
- type: textarea
attributes:
label: Benefits
description: How do you think this feature would improve OpenMage?
validations:
required: false
- 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

0 comments on commit 0f224a5

Please sign in to comment.