-
-
Notifications
You must be signed in to change notification settings - Fork 470
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds GitHub issue forms for bug and crash reports, as well as feature requests. The old `ISSUE_TEMPLATE.md` file was deleted, since blank issues are disabled (usage of forms is required).
- Loading branch information
1 parent
11e68bc
commit 47114f2
Showing
5 changed files
with
213 additions
and
23 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,80 @@ | ||
| name: Bug Report | ||
| description: File a report for unexpected behavior in SuperTux. | ||
| title: "[Bug]: " | ||
| labels: ["type:bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this bug report! | ||
| - type: input | ||
| id: supertux-version | ||
| attributes: | ||
| label: SuperTux Version | ||
| description: The version of SuperTux, shown at the bottom-left corner on the title screen. | ||
| placeholder: ex. v0.6.3-1236-g7451121dd | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: system-info | ||
| attributes: | ||
| label: System Information | ||
| description: Details about your operating system (such as Linux distribution or Windows version) and CPU architecture (ex. 64-bit or 32-bit). | ||
| placeholder: ex. Windows 11 64-bit | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected Behavior | ||
| description: What did you expect to happen? | ||
| placeholder: Describe the behavior you expected in detail. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: actual-behavior | ||
| attributes: | ||
| label: Actual Behavior | ||
| description: Instead, what actually happened? | ||
| placeholder: Describe the actual behavior in detail. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps To Reproduce Actual Behavior | ||
| description: A clear and concise description of how the actual behavior was achieved, since starting up the game. | ||
| placeholder: | | ||
| Describe the steps leading to the actual behavior, preferably with a numerated list. | ||
| 1. ... | ||
| 2. ... | ||
| 3. ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: Additional Information | ||
| description: Include any additional information regarding the bug. | ||
| placeholder: You can also leave this empty. | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| id: guidelines | ||
| attributes: | ||
| label: Guidelines For Reporting Issues | ||
| description: "Before submitting this issue, make sure you have done the following:" | ||
| options: | ||
| - label: I have read <https://github.com/SuperTux/supertux/blob/master/CONTRIBUTING.md#bug-reports>. | ||
| required: true | ||
| - label: I have verified this isn't an issue that's already been reported. | ||
| required: true | ||
| - label: I have verified this isn't a [discussion](https://github.com/SuperTux/supertux/discussions), or an issue about a crash or a feature request, but rather an actual bug ─ that is, the game did something not intended. | ||
| required: true | ||
| - label: I have verified this issue is **not** about wrong translations (use Transifex for those), or anything unsupported (e.g. third-party add-ons). | ||
| required: true | ||
| - label: In this report, I have only included details about **one** (1) bug. | ||
| required: true | ||
| - label: If I make a mistake while submitting this report, I agree to use the "Edit" feature to correct it, instead of closing this issue and opening a new one. | ||
| 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,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Create a Discussion | ||
| url: https://github.com/SuperTux/supertux/discussions/new/choose | ||
| about: If you're looking for something else, create a Discussion, assuming this hasn't been reported there before. |
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,76 @@ | ||
| name: Crash Report | ||
| description: File a report for a crash in SuperTux. | ||
| title: "[Crash]: " | ||
| labels: ["type:crash"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this crash report! | ||
| - type: input | ||
| id: supertux-version | ||
| attributes: | ||
| label: SuperTux Version | ||
| description: The version of SuperTux, shown at the bottom-left corner on the title screen. | ||
| placeholder: ex. v0.6.3-1236-g7451121dd | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: system-info | ||
| attributes: | ||
| label: System Information | ||
| description: Details about your operating system (such as Linux distribution or Windows version) and CPU architecture (ex. 64-bit or 32-bit). | ||
| placeholder: ex. Windows 11 64-bit | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps To Reproduce Crash | ||
| description: A clear and concise description of how the crash was achieved, since starting up the game. | ||
| placeholder: | | ||
| Describe the steps, leading to the crash, preferably with a numerated list. | ||
| 1. ... | ||
| 2. ... | ||
| 3. ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: debug-stacktrace | ||
| attributes: | ||
| label: Debugging Information (Stacktrace) | ||
| description: Include a stacktrace, leading to the crash. This can be obtained via a debugging utility. | ||
| placeholder: | | ||
| Paste the full stacktrace here. | ||
| You can leave this empty, in case a stacktrace can't be obtained (for example, if the game freezes). | ||
| render: shell | ||
| validations: | ||
| required: false | ||
| - type: textarea | ||
| id: additional-info | ||
| attributes: | ||
| label: Additional Information | ||
| description: Include any additional information, regarding the crash. | ||
| placeholder: You can also leave this empty. | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| id: guidelines | ||
| attributes: | ||
| label: Guidelines For Reporting Issues | ||
| description: "Before submitting this issue, make sure you have done the following:" | ||
| options: | ||
| - label: I have read <https://github.com/SuperTux/supertux/blob/master/CONTRIBUTING.md#bug-reports>. | ||
| required: true | ||
| - label: I have verified this isn't an issue that's already been reported. | ||
| required: true | ||
| - label: I have verified this isn't a [discussion](https://github.com/SuperTux/supertux/discussions), or an issue about unintended behavior or a feature request, but rather an actual crash ─ that is, the game closed unexpectedly. | ||
| required: true | ||
| - label: I have verified this issue is **not** about wrong translations (use Transifex for those), or anything unsupported (e.g. third-party add-ons). | ||
| required: true | ||
| - label: In this report, I have only included details about **one** (1) crash. | ||
| required: true | ||
| - label: If I make a mistake while submitting this report, I agree to use the "Edit" feature to correct it, instead of closing this issue and opening a new one. | ||
| 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,52 @@ | ||
| name: Feature Requests | ||
| description: File a request for a feature you want to see in SuperTux! | ||
| title: "[Feature Request]: " | ||
| labels: ["type:idea"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for taking the time to fill out this feature request! | ||
| - type: textarea | ||
| id: feature-details | ||
| attributes: | ||
| label: Feature Details | ||
| description: How would your feature work? | ||
| placeholder: A clear and concise description of the way the feature would function. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: feature-purpose | ||
| attributes: | ||
| label: Feature Purpose | ||
| description: What purpose would your feature serve, towards improving the SuperTux experience? | ||
| placeholder: A list of one or multiple example use-cases or positive outcomes from your feature being in SuperTux. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: feature-screenshots | ||
| attributes: | ||
| label: Concept Screenshots | ||
| description: Include any concept screenshots of the way your feature would look in-game, to help others grasp your idea better. | ||
| placeholder: | | ||
| To attach image files, click this area to highlight it, and then drag the files in. | ||
| You can also leave this empty. | ||
| validations: | ||
| required: false | ||
| - type: checkboxes | ||
| id: guidelines | ||
| attributes: | ||
| label: Guidelines For Reporting Issues | ||
| description: "Before submitting this issue, make sure you have done the following:" | ||
| options: | ||
| - label: I have read <https://github.com/SuperTux/supertux/blob/master/CONTRIBUTING.md#bug-reports>. | ||
| required: true | ||
| - label: I have verified this isn't a request that's already been submitted as an issue. | ||
| required: true | ||
| - label: I have verified this isn't a [discussion](https://github.com/SuperTux/supertux/discussions), or an issue with the game, but rather an actual feature request - a currently non-existent, but desired feature. | ||
| required: true | ||
| - label: In this request, I have only included details about **one** (1) desired feature. | ||
| required: true | ||
| - label: If I make a mistake while submitting this request, I agree to use the "Edit" feature to correct it, instead of closing this issue and opening a new one. | ||
| required: true |