Skip to content

Commit e5143a4

Browse files
jumpingpxljumpingpxl
committed
add issue templates
1 parent 52cb36d commit e5143a4

File tree

3 files changed

+146
-1
lines changed

3 files changed

+146
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
name: "Report a Bug"
2+
description: Found a Bug that needs to be fixed?
3+
labels: [
4+
"pending",
5+
"bug"
6+
]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |-
11+
Please join our [Discord Server for Developers](https://labymod.net/dc/dev) if you have questions about the LabyMod 4 Server API.
12+
13+
Keep in mind that this isn't the place to learn Java.
14+
Please head over to [Stack Overflow](https://stackoverflow.com/questions/tagged/java) for your general programming questions.
15+
- type: checkboxes
16+
attributes:
17+
label: General Troubleshooting
18+
description: Please confirm you checked the following before submitting your issue.
19+
options:
20+
- label: I am using the [latest version](https://github.com/LabyMod/labymod4-server-api/releases) of the LabyMod 4 Server API.
21+
required: true
22+
- label: I am using the latest version of LabyMod.
23+
required: true
24+
- label: I have checked for similar issues on the [Issue-tracker](https://github.com/LabyMod/labymod4-server-api/issues).
25+
required: true
26+
- label: I have checked for Pull Requests that might already address this issue.
27+
required: true
28+
- type: dropdown
29+
id: platform
30+
attributes:
31+
label: "Platforms"
32+
description: What platform are you experiencing the problem on?
33+
multiple: true
34+
options:
35+
- Spigot / Bukkit
36+
- BungeeCord
37+
- Velocity
38+
- Custom Server Platform
39+
- Addon API
40+
- Other (please specify in the additional information text field at the bottom)
41+
validations:
42+
required: true
43+
- type: dropdown
44+
id: version
45+
attributes:
46+
label: "Affected Minecraft Version(s)"
47+
description: What Minecraft version(s) are you experiencing the problem on?
48+
options:
49+
- 1.8.9
50+
- 1.12.2
51+
- 1.16.5
52+
- 1.17.1
53+
- 1.18.2
54+
- 1.19.2-1.19.4
55+
- 1.20.1-1.20.4
56+
- 1.20.5-1.20.6
57+
- 1.21.x
58+
- Other / Not Listed (please specify in the additional information text field at the bottom)
59+
validations:
60+
required: true
61+
- type: textarea
62+
attributes:
63+
label: "Expected Behaviour"
64+
description: "What did you expect to happen?"
65+
placeholder: "I expected ... to happen"
66+
validations:
67+
required: true
68+
- type: textarea
69+
attributes:
70+
label: "Code Example for Reproduction Steps"
71+
description: |-
72+
Please add the code you use to reproduce this problem.
73+
Make sure to remove or replace any sensitive data.
74+
Leave this empty or put "N/A" if you don't have a reproducible setup.
75+
76+
The provided text will be rendered as Java code, so you don't have to provide a Code block for it.
77+
render: java
78+
placeholder: |-
79+
public void causeError() {
80+
throw new Exception("Error!");
81+
}
82+
validations:
83+
required: true
84+
- type: textarea
85+
attributes:
86+
label: "Exception or Error"
87+
description: |-
88+
Share any Exception or Error you encountered.
89+
Make sure to put it into a code block for better formatting.
90+
Leave this blank or put "N/A" if you don't have an Exception or Error.
91+
92+
The provided text will be rendered as code, so you don't have to provide a Code block for it.
93+
render: yesyes # Unknown code-names = no highlighting.
94+
placeholder: "java.lang.NullPointerException: null"
95+
validations:
96+
required: true
97+
- type: textarea
98+
attributes:
99+
label: "Additional Information"
100+
description: |-
101+
Add any additional information that might help us understand the problem better.
102+
This could be a more detailed explanation of the problem, a possible solution, or any other information you think is relevant.
103+
placeholder: "I think the problem is caused by ..."

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: "Request a new Feature"
2+
description: Request a new Feature for the LabyMod 4 Server API.
3+
labels: [
4+
"pending",
5+
"enhancement"
6+
]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |-
11+
Please join our [Discord Server for Developers](https://labymod.net/dc/dev) if you have questions about the LabyMod 4 Server API.
12+
13+
Keep in mind that this isn't the place to learn Java.
14+
Please head over to [Stack Overflow](https://stackoverflow.com/questions/tagged/java) for your general programming questions.
15+
- type: checkboxes
16+
attributes:
17+
label: General Troubleshooting
18+
description: Please confirm you checked the following before submitting your issue.
19+
options:
20+
- label: I am using the [latest version](https://github.com/LabyMod/labymod4-server-api/releases) of the LabyMod 4 Server API.
21+
required: true
22+
- label: I have checked for similar issues on the [Issue-tracker](https://github.com/LabyMod/labymod4-server-api/issues).
23+
required: true
24+
- label: I have checked for Pull Requests that might already address this issue.
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: "Feature Request"
29+
description: "Provide a small description of the feature you want to have added."
30+
placeholder: "The LabyMod 4 Server API should get ..."
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: "Example Use-Case"
36+
description: |-
37+
Provide some code or describe a possible use-case for this feature.
38+
39+
The provided text will be rendered as Java code, so you don't have to provide a Code block for it.
40+
placeholder: "public void newAwesomeMethod(){}"
41+
render: java

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ own integration can be found on the [LabyMod Developer Portal](https://wiki.laby
3131
## Usage
3232

3333
An extensive guide on how to use the LabyMod 4 Server API can be found on
34-
the [LabyMod Developer Portal](https://wiki.labymod.net).
34+
the [LabyMod Developer Portal](https://wiki.labymod.net). Alternatively, feel free to ask for help on
35+
our [Discord Server for Developers](https://labymod.net/dc/dev).
3536

3637
## Building
3738

0 commit comments

Comments
 (0)