Archive/TombEngine
0
0
Fork 0
mirror of https://github.com/TombEngine/TombEngine.git synced 2025-04-28 07:47:57 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Create bug report and feature request forms (#1366)

Browse source 
In order to promote concise bug reports / feature requests for TombEngine : myself and @Jakub768 have created some forms in YAML for the TombEngine Github page.

Due to the nature of this being online and rendered by Github , previewing the changes cannot be done with an external tool. So this initial branch will now be merged and then further tweaks will take place if needs be.

Co-authored-by: Jakub <kubabilinski03@gmail.com>
This commit is contained in:
Stranger1992 2024-05-15 21:40:05 +01:00 • committed by GitHub
parent 04c0238936
commit 356480b5dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 154 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

36
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -1,36 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG REPORT] "
labels: Awaiting Triage
assignees: ''
---
### **Version**
- TombEngine Version Number: _insert here_
- Tomb Editor Version Number: _insert here_
### **Describe the bug**
_A clear and concise description of what the bug is_
### **To Reproduce**
_To reproduce the behaviour, please provide detailed steps for the development team to follow. This can be done through screenshots or a written guide_
**If the bug cannot be reproduced, and if the issue is not adequately explained, it will be closed without further investigation**
### **Expected behaviour**
A clear and concise description of what you expected to happen.
### **Screenshots**
If applicable, add screenshots to help explain your problem.
### **Additional context**
Add any other context about the problem here.
* Are you testing an build of a TombEngine that has not yet been released? If so please give some context.
* Did you get any asset from the TombEngine website that has presented a bug?
### **Please upload a .zip file containing your level and all assets needed to compile the level and a cut-down version of your level where the bug presents itself**

103
.github/ISSUE_TEMPLATE/bug_report.yaml vendored Normal file
View file

@ -0,0 +1,103 @@
name: Bug report
description: Create a report to help us improve
title: "[BUG REPORT]"
labels: Awaiting Triage
body:
- type: markdown
attributes:
value: |
Please follow this document in order to report a bug
- type: input
attributes:
label: Engine version
description: |
- Please specify TombEngine Version Number in the following input box.
placeholder: |
- TombEngine Version Number 1.1.0
validations:
required: true
- type: input
attributes:
label: Editor version
description: |
- Please specify Tomb Editor Version Number in the following input box.
placeholder: |
- TombEngine Version Number 1.1.0
validations:
required: true
- type: textarea
attributes:
label: Describe the bug
description: |
Please provide A clear and concise description of what the bug is.
placeholder: |
Your bug report here.
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
description: |
To reproduce the behaviour, please provide detailed steps for the development team to follow. This can be done through screenshots or a written guide
**If the bug cannot be reproduced, and if the issue is not adequately explained, it will be closed without further investigation**
placeholder: |
Provide detailed reproducible steps here.
validations:
required: true
- type: textarea
attributes:
label: Expected Behaviour
description: |
A clear and concise description of what you expected to happen.
placeholder: |
A description of what should happen here.
validations:
required: true
- type: textarea
attributes:
label: Screenshots
description: |
Please check this box if you have provided screenshots or any other media for this issue
**note** If you do not provide screenshots or anything else, it may be hard for devs to investigate
provide a link to your screenshot here or simply drag and drop your screenshot into this textbox
placeholder: |
A description of any additional content here.
validations:
required: true
- type: textarea
attributes:
label: Additional Content
description: |
Add any other context about the problem here.
* Are you testing an build of a TombEngine that has not yet been released? If so please give some context.
* Did you get any asset from the TombEngine website that has presented a bug?
placeholder: |
A description of any additional content here.
validations:
required: true
- type: textarea
attributes:
label: Minimal reproduction project
description: |
**Please upload a .zip file containing your level and all assets needed to compile the level and a cut-down version of your level where the bug presents itself**
The project can be uploaded as a zip file (10 mb max) or provide a link from google drive, dropbox etc.
**Note** if you do not provide this, your issue may be rejected
placeholder: |
Download link to your project
validations:
required: true

18
.github/ISSUE_TEMPLATE/config.yml vendored
View file

@ -1 +1,17 @@
blank_issues_enabled: false
blank_issues_enabled: false
# Disable blank issue
blank_issues_enabled: false
# Bug Report Form
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: [ "Awaiting Triage" ]
# Initial Message
body:
type: markdown
attributes:
value: Thanks for taking the time to fill out this bug report! Please use the steps below to log the report for the development team.

20
.github/ISSUE_TEMPLATE/feature-request.md vendored
View file

@ -1,20 +0,0 @@
---
name: Feature Request
about: Suggest an idea for TombEngine
title: "[ Feature Request ] "
labels: Awaiting Triage
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

34
.github/ISSUE_TEMPLATE/feature-request.yaml vendored Normal file
View file

@ -0,0 +1,34 @@
name: Feature Request
description: Suggest an idea for TombEngine
title: "[ Feature Request ] "
labels: Awaiting Triage
body:
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
attributes:
label: Describe the solution you'd like
placeholder: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives you've considered
placeholder: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: true
- type: textarea
attributes:
label: Additional context
placeholder: Add any other context or screenshots about the feature request here. (as a link to screenshot or drop the screenshot into this textbox)
validations:
required: true