forked from tgstation/tgstation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrates Issue Reporting to the New GitHub Template Format (tgstation…
…#85909) ## About The Pull Request Screenshots slightly outdated, check it out here for the latest: https://github.com/san7890/bruhstation/blob/issue-reporting/.github/ISSUE_TEMPLATE/bug_report_form.yml Gone are the days of copypasting markdowns and people leaving out important information! A much cleaner form is upon us! ![image](https://github.com/user-attachments/assets/9639014d-5206-405a-901f-ddcba1f48c1e) First off, the button will now automatically redirect people to the forums for feature requests. No more accidental entries through blank MDs, should be a lot cleaner. If it is a valid issue report, you'll be navigated to this menu. No more having to worry about putting comments in the input field as the important information is fully visible in the form: <details> <summary>Template Image</summary> ![image](https://github.com/user-attachments/assets/580a0162-7e99-491d-9dc2-98e0c07e6eaf) </details> This will be the end result of filling in all the fields: <details> <summary>End Result</summary> ![image](https://github.com/user-attachments/assets/59dd1eb4-29ba-48f4-b989-7cbafcdab5e0) ```md ### Client Version 515.1642 ### Issue Summary insert blank here ### Round ID _No response_ ### Test Merges perhaps ### Reproduction steps alirght ``` </details> I updated the BYOND-side code to ensure that this would work just as it did prior, auto-filling the applicable fields that we generate ingame. ## Why It's Good For The Game Far more clarity to people who wish to report issues, no more worrying about comment formatting, can have mandatory fields, just a cleaner experience overall. ## Changelog :cl: qol: Reporting issues on the Github should now be a far more simpler experience. Hitting the "Report Issue" button in the top-right of your BYOND Client Screen will still autofill in the fields as expected. /:cl: Ignore how dumb the commit history of this branch is. --------- Co-authored-by: MrMelbert <[email protected]>
- Loading branch information
Showing
5 changed files
with
102 additions
and
69 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
name: Bug Report | ||
description: Create a report to help reproduce and fix the issue. | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
# **Please read the following guidelines. Follow all instructions or else your issue is subject to closure.** | ||
## If you use the "Report Issue" button in the top-right corner of the game, it will automatically fill in some of the information below. | ||
If you are reporting an issue found in another branch or codebase, you _must_ link the branch or codebase repo in your issue report or it will be closed. | ||
For branches, If you have not pushed your code up, please either reproduce it on master or push your code up before making an issue report. | ||
For other codebases, if you do not have a public code repository you will be refused help unless you can completely reproduce the issue on our master branch. | ||
- type: input | ||
id: reporting-version | ||
attributes: | ||
label: "Client Version:" | ||
description: | | ||
The BYOND version you are using to report this issue. You can find this information in the bottom left corner of the "About BYOND" window in the BYOND client. | ||
It is strongly recommended that you include this, especially for concerns on the visual aspects of the game. | ||
placeholder: "xxx.xxxx" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: issue-summary | ||
attributes: | ||
label: "Issue Summary:" | ||
description: | | ||
Briefly explain your issue in a few plain sentences. You may copy and paste the issue title here if it is suitable. | ||
placeholder: | | ||
"When I do X, Y happens instead of Z." | ||
"X on Y map has Z issue." | ||
validations: | ||
required: true | ||
- type: input | ||
id: round-id | ||
attributes: | ||
label: "Round ID:" | ||
description: | | ||
If you discovered this issue from playing tgstation hosted servers, the Round ID can be found in the Status panel or retrieved from https://statbus.space/ | ||
The Round ID lets us look up valuable information and logs for the round the bug happened. Leave this blank if there is no round ID. | ||
placeholder: "XXXXXX" | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: test-merges | ||
attributes: | ||
label: "Test Merge Information:" | ||
description: | | ||
If you're certain the issue is to be caused by a test merge [OOC Tab -> Show Server Revision], report it in the pull request's comment section rather than on the tracker. | ||
If you're unsure you can refer to the issue number by prefixing said number with #. The issue number can be found beside the title after submission of this form. | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: "Reproduction Steps:" | ||
description: | | ||
Describe the steps to reproduce the issue in detail. Include any relevant information, such as the map, round type, and any other factors that may be relevant. | ||
If it is a runtime-related error, please include the runtime here as that is pertient information. Issues are not for oddities introduced by admin varedits, ensure these occur in normal circumstances. | ||
placeholder: | | ||
1. Go to the X location | ||
2. Do Y action | ||
3. Observe Z result | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
contact_links: | ||
- name: Feature Requests | ||
url: https://tgstation13.org/phpBB/viewforum.php?f=9 | ||
about: Post feature requests and suggestions on the forums. This repository does not handle them. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters