Skip to content

Commit

Permalink
add issue templates (#380)
Browse files Browse the repository at this point in the history
* add issue templates

* forgot to remove a sentence

* "bug" -> "issue"

* reword the description

* "suggestion" -> "request"

* add mc wiki link describing how to obtain crash reports

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/bug_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* remove welcome messages

* bug_report.yml -> crash_report.yml

* feature_request.yml -> api_request.yml

* add "library" and "module" fields and reword stuff in api_request.yml

* better formatting

* reword a few more things

* add a bug report template

* "bug" -> "crash"

* "side" -> "environment"

* add qsl_bug_report.yml, albeit this probably needs more work

* bug_report.yml -> game_issue_report.yml

* combine two input fields for a QSL lib/module request

* edit auto-applied labels

* Update .github/ISSUE_TEMPLATE/game_issue_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/crash_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/config.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/qsl_bug_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/game_issue_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/api_request.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/game_issue_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/api_request.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/api_request.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/crash_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* Update .github/ISSUE_TEMPLATE/game_issue_report.yml

Co-authored-by: Eli Orona <eliorona@live.com>

* remove "feature"

---------

Co-authored-by: Eli Orona <eliorona@live.com>
  • Loading branch information
woodiertexas and OroArmor authored Aug 24, 2024
1 parent 98790eb commit 8fb51ed
Show file tree
Hide file tree
Showing 5 changed files with 145 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/api_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: API Request
description: Create an API request for Quilt Standard Libraries.
labels: [enhancement, help wanted, t: new api]
body:
- type: markdown
attributes:
value: |
Thanks for taking your time to create your API request! If you want to discuss your request, join us on [Discord](https://discord.quiltmc.org).
- type: textarea
id: description
attributes:
label: Describe what API(s) you want.
description: "Describe what API you believe QSL should implement. What does the API do? Is there a similar implementation, and if so how should QSL differ from it? The more detailed your request is the easier it will be for people to begin implementation of the API."

- type: textarea
id: library-or-module
attributes:
label: Where does your API fit into QSL's structure? Which library and module? Does this add a new library or module?

- type: textarea
id: additional-info
attributes:
label: Additional Information
description: "Add any other information about your API request here."
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Join the Discord for support.
url: https://discord.quiltmc.org
about: Discuss Quilt Standard Libraries on our Discord server.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/crash_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Crash Report
description: Create a crash report to receive support for a breaking issue.
labels: [support, crash]
body:
- type: markdown
attributes:
value: |
Thanks for taking your time to report this crash! If you need real-time help, join us on [Discord](https://discord.quiltmc.org).
- type: textarea
id: description
attributes:
label: Describe the crash
description: "Describe the crash as clearly as possible. The more detail you provide means the sooner you can get back to your game! This includes: steps to reproduce or situation right before the crash, recent changes you made to your mods list, or any additional context that could be helpful."
validations:
required: true

- type: dropdown
id: environment
attributes:
label: Which environment crashed?
options:
- Client
- Server
- Both
validations:
required: true

- type: input
id: logs
attributes:
label: Logs
description: |
If applicable (crash, error output in console), please provide your crash report or latest.log
To upload logs, use [MCLogs](https://mclo.gs/) to upload your crashlog or latest.log. If you are unsure of how to obtain a crash report, read [here](https://minecraft.wiki/w/Tutorials/Obtaining_a_crash_report).
Crash reports without a crashlog or a latest.log file will be marked as invalid. Crashes are hard to fix without the crashlogs or latest.log file(s).
- required: true
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/game_issue_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Game Issue
description: Create a "game issue" report to receive support for a non-crashing issue.
labels: [support, bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking your time to report the game issue you encountered! If you need real-time help, join us on [Discord](https://discord.quiltmc.org).
- type: textarea
id: description
attributes:
label: Describe the issue
description: "Describe the issue as clearly as possible. The more detail you provide means the sooner the issue can be fixed! This includes: steps to reproduce or situation you encountered the issue in, recent changes you made to your mods list, or any additional context that could be helpful."
validations:
required: true

- type: dropdown
id: environment
attributes:
label: Which environment did you encounter this issue in?
options:
- Client
- Server
- Both
validations:
required: true

- type: input
id: logs
attributes:
label: Logs
description: |
If applicable, please provide your latest.log
To upload logs, use [MCLogs](https://mclo.gs/) to upload your latest.log.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/qsl_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: QSL-specific Bug Report
description: Create a bug report to help us fix issues with Quilt Standard Libraries.
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thanks for taking your time to report this bug! If you need real-time help, join us on [Discord](https://discord.quiltmc.org).
- type: textarea
id: description
attributes:
label: Describe the bug
description: "Describe the bug as clearly as possible. The more detail you provide means the sooner the bug can be fixed! This includes: steps to reproduce or situation you encountered the bug in, recent changes you made to your mods list, or any additional context that could be helpful."
validations:
required: true

- type: textarea
id: where-in-qsl
attributes:
label: How did QSL break?
description: "What part of the game broke? Which QSL modules were in the stack trace? Is it possible to provide a GitHub link to the section of QSL that is broken?"
validations:
required: true

- type: dropdown
id: environment
attributes:
label: Which environment did you encounter this bug in?
options:
- Client
- Server
- Both
validations:
required: true

- type: input
id: logs
attributes:
label: Logs
description: |
If applicable, please provide your crash report or latest.log
To upload logs, use [MCLogs](https://mclo.gs/) to upload your latest.log. If you are unsure of how to obtain a log, read [here](https://minecraft.wiki/w/Tutorials/Obtaining_a_crash_report).

0 comments on commit 8fb51ed

Please sign in to comment.