cyberpresidentvanellope/Paradise
1
0
Fork 0
mirror of https://github.com/ParadiseSS13/Paradise.git synced 2026-08-24 20:47:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

Modernises issue reports using templates. (#23104)

Browse Source 
* update issue templates

* Modern!

* adds required text for required fields

* make this logical

* inclusivity for all types of issues, not just bugs

* Apply suggestions from code review

Co-authored-by: DGamerL <108773801+DGamerL@users.noreply.github.com>

* Apply suggestions from code review

---------

Co-authored-by: DGamerL <108773801+DGamerL@users.noreply.github.com>
This commit is contained in:
S34N
2023-11-04 16:22:37 -04:00
committed by GitHub
co-authored by DGamerL
parent ec21a774b7
commit a9596307d9
3 changed files with 105 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug_report.yml
-57
View File
@@ -1,57 +0,0 @@
#For more details
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.gitea.com/1.19/usage/issue-pull-request-templates
#Be sure to check the docs
#
#Format
#- type: | markdown | textarea | input | checkboxes |
# id: | just an id, no actual relevance |
# attributes:
# label: | Box title |
# description: | Box small text - Description |
#
name: Bug Report
#title: "[Bug]: " | if you want to have a have it automatically say [Bug] when they start the form
description: Create a report to help us improve.
#labels: [Bug] | Auto labels the post, as we do not use this, commenting out, purely as reference
body:
- type: markdown
attributes:
value: "**IMPORTANT** <br> If your issue is an ingame exploit that allows players to gain an unfair advantage, or an issue which could affect server stability or security, please file it at https://www.paradisestation.org/forum/179-exploit-reports/ so that it is safe from prying eyes"
- type: textarea
id: Issue
attributes:
label: Issue Description
description: What is the problem?
- type: textarea
id: What-Happened
attributes:
label: What did you expect to happen
description: Why do you think this is an issue?
- type: textarea
id: What-Instead
attributes:
label: What happened instead
description: How is what happened different from what you expected?
- type: textarea
id: Why
attributes:
label: Why is this bad/What are the consequences
description: Why do you think this is an important issue?
- type: textarea
id: How
attributes:
label: Steps to reproduce the problem
description: The most important section. Review everything you did leading up to causing the issue.
- type: textarea
id: When
attributes:
label: When did the problem start happening
description: If your report is about something that used to work but no longer does, when was the last time you remember it working?
- type: textarea
id: Extra-Info
attributes:
label: Extra information
description: If your report is about something that used to work but no longer does, when was the last time you remember it working?
placeholder: Relevant Images, Round ID etc.
.github/ISSUE_TEMPLATE/config.yml
+6 -7
View File
@@ -1,12 +1,11 @@
#DOCS
#https://docs.github.com/en/github-ae@latest/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
#
blank_issues_enabled: false
contact_links:
- name: Feature Request
url: https://www.paradisestation.org/forum/60-suggestions/
about: Please place all feature requests here
- name: Exploit Report
url: https://www.paradisestation.org/forum/179-exploit-reports/
about: Exploit reports go on the forum
- name: Feature Request
url: https://www.paradisestation.org/forum/60-suggestions/
about: Please place all feature requests at the following link. (Paradise Station Forums)
- name: Exploit Reports
url: https://www.paradisestation.org/forum/179-exploit-reports/
about: If your issue is an ingame exploit that allows players to gain an unfair advantage, or an issue which could affect server stability or security, please file it here so that it is safe from prying eyes. (Paradise Station Forums)
.github/ISSUE_TEMPLATE/issue_report.yml
+99
View File
@@ -0,0 +1,99 @@
#For more details
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
# https://docs.gitea.com/1.19/usage/issue-pull-request-templates
#Be sure to check the docs
#
#Format
#- type: | markdown | textarea | input | checkboxes |
# id: | just an id, no actual relevance |
# attributes:
# label: | Box title |
# description: | Box small text - Description |
#
name: "Issue Report"
#title: "[Bug]: " | if you want to have a have it automatically say [Bug] when they start the form
description: "File an issue report to make us aware of a bug or issue."
#labels: [Bug] | Auto labels the post, as we do not use this, commenting out, purely as reference
body:
- type: markdown
attributes:
value: Thanks for taking the time to fill out this issue report! Don't forget to give it a meaningful title so users can find the report easily.
- type: checkboxes
id: not_an_exploit
attributes:
label: Exploit Reports
description: "[If your issue is an ingame exploit that allows players to gain an unfair advantage, or an issue which could affect server stability or security, please file it at this link so that it is safe from prying eyes.](https://www.paradisestation.org/forum/179-exploit-reports/)"
options:
- label: I confirm this issue is not an exploit. (Required)
required: true
- type: input
id: version
attributes:
label: BYOND Version
description: "What BYOND version were you using when the issue occured? (Find this by pressing the cog in the top-right of the main BYOND menu, then 'About BYOND...') (Required)"
validations:
required: true
- type: textarea
id: description
attributes:
label: Issue Description
description: What is the problem? (Required)
placeholder: I tried buckling myself to a chair but ended up on lavaland!
validations:
required: true
- type: textarea
id: what-expected
attributes:
label: What did you expect to happen?
description: Why do you think this is an issue?
placeholder: I expected to be strapped to a chair.
- type: textarea
id: what-happened
attributes:
label: What happened instead?
description: How is what happened different from what you expected?
placeholder: I got sent to lavaland and died.
- type: textarea
id: why-bad
attributes:
label: Why is this bad/What are the consequences?
description: Why do you think this is an important issue?
placeholder: People sitting in chairs on the station should not end up being devoured by drakes.
- type: textarea
id: how-to-reproduce
attributes:
label: Steps to reproduce the issue.
description: The most important section. Review everything you did leading up to causing the issue. (Required)
placeholder: Find a chair, buckle yourself into it, be eaten by dragon.
validations:
required: true
- type: textarea
id: when-problem-start
attributes:
label: When did the problem start happening?
description: If your report is about something that used to work but no longer does, when was the last time you remember it working? (Required)
placeholder: I could sit fine last week, so sometime around then.
validations:
required: true
- type: textarea
id: extra-information
attributes:
label: Extra information
description: Anything else you can tell us.
placeholder: "I think this issue was introduced in the following PR https://github.com/ParadiseSS13/Paradise/pull/18477"
- type: textarea
id: logs
attributes:
label: Relevant log output/runtime error
description: Please copy and paste any relevant log output or runtime if you have access to this. Please censor any ckeys or IP addresses.
render: DM