Skip to content

Commit 2554321

Browse files
committed
Add issue template for SpongeAPI
1 parent bf47737 commit 2554321

File tree

2 files changed

+91
-0
lines changed

2 files changed

+91
-0
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Feature or Implementation Request for Sponge Implementations
4+
url: https://github.com/SpongePowered/Sponge/issues/new?assignees=&labels=status%3A+needs+triage%2Ctype%3A+feature+request&template=feature_request.yml
5+
about: "If you're using an API and it fails with an abstract method or no class def error, report it here."
6+
- name: Bug report for Sponge for Minecraft 1.16.5 or later
7+
url: https://github.com/SpongePowered/Sponge/issues/new?assignees=&labels=status%3A+needs+triage%2Ctype%3A+bug&template=bug_report.yml
8+
about: "If you've discovered a bug with Sponge itself, report that here."
9+
- name: Bug report for SpongeForge for Minecraft 1.12.2
10+
url: https://github.com/SpongePowered/SpongeForge/issues/new?assignees=&labels=&template=legacy_issue.yml
11+
about: "Issues for SpongeForge for Minecraft 1.12.2 should be reported on the SpongeForge repository."
12+
- name: Bug report for SpongeVanilla for Minecraft 1.12.2
13+
url: https://github.com/SpongePowered/SpongeVanilla/issues/new?assignees=&labels=&template=legacy_issue.yml
14+
about: "Issues for SpongeVanilla for Minecraft 1.12.2 should be reported on the SpongeVanilla repository."
15+
- name: Known Mod Incompatibilities
16+
url: https://docs.spongepowered.org/stable/en/server/spongineer/incompatible.html
17+
about: "If you're potentially having issues with mod conflicts, read this page. You may simply need to change a mod or sponge setting."
18+
- name: Sponge Docs
19+
url: https://docs.spongepowered.org/
20+
about: "If you need help setting up a server, our Docs pages may help you."
21+
- name: Sponge Forums
22+
url: https://forums.spongepowered.org/
23+
about: "If you need support running your server and want to ask a question, post on our official forums"
24+
- name: Sponge Discord Guild
25+
url: https://discord.gg/sponge
26+
about: "For quick help, join our Discord channel!"
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Request Addition or Change to API
2+
description: If you want a new API or are requesting a change to an API, ask here.
3+
labels: [ "status: needs triage" ]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: "## Before You Begin"
8+
- type: markdown
9+
attributes:
10+
value: >
11+
This is for requesting a new API to an existing version of the SpongeAPI, or for requesting a change that will
12+
appear in newer versions of the API. This is **not** for reporting errors when trying to use an API in one of
13+
our implementations - if you are getting `AbtractMethodError`s or `NoClassDefError`s, [please report that to the
14+
Sponge repository instead](https://github.com/SpongePowered/Sponge/issues/new/choose).
15+
16+
17+
Please make sure you have searched existing issues to see if someone else has made the same request as you first.
18+
We will close duplicates.
19+
20+
21+
Remember, Github Issues is not for support. If you require help, visit the
22+
[Sponge Docs](https://docs.spongepowered.org), our [Forums](https://forums.spongepowered.org) or
23+
[Discord Server](https://discord.gg/sponge).
24+
- type: dropdown
25+
id: type
26+
- type: input
27+
id: version
28+
attributes:
29+
label: Major SpongeAPI version
30+
description: What major version of the API do you want this to target?
31+
placeholder: ex. 8, 9
32+
validations:
33+
required: true
34+
- type: dropdown
35+
id: breakingchange
36+
attributes:
37+
label: Is this likely to be a breaking change?
38+
description: >
39+
A breaking change can be, but is not limited to:
40+
41+
* A method is removed from an class/interface
42+
* A method's signature is changed (including the number of parameters, the types of those parmaeters, and
43+
the return type of a method) instead of adding an overload (note that changing a return type from `void` to
44+
something else, such as `boolean` is still a breaking change).
45+
* A class/interface is removed or renamed, or is converted between a class and an interface
46+
* The inheritance tree is modified (other than simply being added to)
47+
48+
If you are unsure, select "I don't know". **Breaking changes can only target unreleased major versions.**
49+
options:
50+
- Yes
51+
- No
52+
- I don't know
53+
validations:
54+
required: true
55+
- type: textarea
56+
id: what-do-you-want
57+
attributes:
58+
label: What are you requesting?
59+
description: >
60+
Explain what what you're requesting and why you're requesting it. Please add as much detail as you can.
61+
Feel free to give suggestions as to the form of the API you want - it doesn't need to be exact at this stage
62+
as we may help you refine your idea.
63+
validations:
64+
required: true
65+

0 commit comments

Comments
 (0)