Skip to content

Commit cac9a9e

Browse files
Adding new issue templates and configuration of the issue templates.
1 parent 79ee759 commit cac9a9e

File tree

5 files changed

+117
-41
lines changed

5 files changed

+117
-41
lines changed
+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Bug Report
2+
description: Report a bug within the SA Tools Suite
3+
title: "[Bug Report]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a bug report. Please be include the name of the program(s) affected in the title. Be sure to include as much information as you can in the required fields.
10+
- type: checkboxes
11+
id: review
12+
attributes:
13+
label: Report Verification
14+
options:
15+
- label: I have reviewed existing issues on this repository and my issue is not currently reported.
16+
required: true
17+
- label: The issue I'm reporting is for a program in the SA Tools.
18+
required: true
19+
- type: textarea
20+
id: report
21+
attributes:
22+
label: Please provide details regarding the bug you experienced. Do not include reproduction steps here.
23+
validations:
24+
required: true
25+
- type: textarea
26+
id: repro
27+
attributes:
28+
label: Reproduction Steps
29+
description: Please provide steps that will reproduce the error.
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: crash-report
34+
attributes:
35+
label: Crash Report
36+
description: If the program crashed and provided a crash report or log, please provide it here.
37+
validations:
38+
required: false
39+
- type: dropdown
40+
id: os
41+
attributes:
42+
label: Please select your Operating System.
43+
multiple: false
44+
options:
45+
- Windows
46+
- Linux
47+
- MacOS
48+
validations:
49+
required: true
50+
- type: input
51+
id: os-version
52+
attributes:
53+
label: Operation System Information
54+
description: Please provide the version of your Operating System. If you're using Linux or MacOS, please provide the emulation layer you're using.
55+
validations:
56+
required: true
57+
- type: textarea
58+
id: additional
59+
attributes:
60+
label: Additional Information
61+
description: If you have additional information or files that are needed to reproduce the issue, please include them in this field.
62+
validations:
63+
required: false
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Feature Request
2+
description: File a feature request or enhancement for the tools.
3+
title: "[Feature Request]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please provide information on your feature request below. Be sure to include which program(s) are part of your request in the title of this report.
10+
- type: textarea
11+
id: request
12+
attributes:
13+
label: Request Information
14+
description: Please provide details regarding the feature you would like to see added to the SA Tools.
15+
validations:
16+
required: true
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Documentation
2+
description: Report an issue with (or a lack of) documentation pertaining to the SA Tools.
3+
title: "[Documentation]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
In the fields below, please provide what information you can regarding the issue with documentation you have found.
10+
- type: input
11+
id: link
12+
attributes:
13+
label: Documentation Source
14+
description: If your issue is with existing documentation, please provide a link to the relevant documentation below.
15+
placeholder: e.g. https://github.com/X-Hax/sa_tools/wiki/SA-Tools-Hub
16+
validations:
17+
required: false
18+
- type: textarea
19+
id: issue
20+
attributes:
21+
label: Documentation Issue
22+
description: Please provide information regarding what is wrong with the documentation or where the documentation may be lacking.
23+
validations:
24+
required: true

.github/ISSUE_TEMPLATE/config.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: SA Mod Manager
4+
url: https://github.com/X-Hax/SA-Mod-Manager
5+
about: Issues with the Mod Manager for SADX and SA2 should be reported here.
6+
- name: SADX Mod Loader
7+
url: https://github.com/X-Hax/sadx-mod-loader
8+
about: Issues with the SADX Mod Loader should be reported here.
9+
- name: SA2 Mod Loader
10+
url: https://github.com/X-Hax/sa2-mod-loader
11+
about: Issues with the SA2 Mod Loader should be reported here.
12+
- name: Blender SAIO Addon
13+
url: https://github.com/X-Hax/SonicAdventureBlenderIO
14+
about: Issues with the SAIO Blender addon should be reported here.

.github/ISSUE_TEMPLATE/new-issue.md

-41
This file was deleted.

0 commit comments

Comments
 (0)