Skip to content

Commit f1930c1

Browse files
jumpingpxljumpingpxl
committed
add issue templates
1 parent c03b24b commit f1930c1

File tree

3 files changed

+159
-0
lines changed

3 files changed

+159
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

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

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Create Issue for the LabyMod 4 Server API
4+
url: https://github.com/LabyMod/labymod4-server-api/issues/new/choose
5+
about: Issues on this repository are only for integrations of the LabyMod 4 Server API. For the LabyMod 4 Server API itself, please use the following link.
6+
- name: Need Help?
7+
url: https://labymod.net/dc/dev
8+
about: Join our Discord server to ask for help regarding the LabyMod 4 Server API.
9+
- name: LabyMod Developer Portal
10+
url: https://wiki.labymod.net/
11+
about: Check out our Developer Portal to understand the LabyMod 4 Server API better.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
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 want to request a feature regarding an integration of the LabyMod 4 Server API.
21+
required: true
22+
- label: I am using the [latest version](https://github.com/LabyMod/labymod4-server-api/releases) of the LabyMod 4 Server API.
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: textarea
29+
attributes:
30+
label: "Feature Request"
31+
description: "Provide a small description of the feature you want to have added."
32+
placeholder: "The LabyMod 4 Server API should get ..."
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: "Example Use-Case"
38+
description: |-
39+
Provide some code or describe a possible use-case for this feature.
40+
41+
The provided text will be rendered as Java code, so you don't have to provide a Code block for it.
42+
placeholder: "public void newAwesomeMethod(){}"
43+
render: java

0 commit comments

Comments
 (0)