|
| 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: input |
| 25 | + id: version |
| 26 | + attributes: |
| 27 | + label: Major SpongeAPI version |
| 28 | + description: What major version of the API do you want this to target? |
| 29 | + placeholder: ex. 8, 9 |
| 30 | + validations: |
| 31 | + required: true |
| 32 | + - type: dropdown |
| 33 | + id: breakingchange |
| 34 | + attributes: |
| 35 | + label: Is this likely to be a breaking change? |
| 36 | + description: > |
| 37 | + A breaking change can be, but is not limited to: |
| 38 | + |
| 39 | + |
| 40 | + * A method is removed from an class/interface |
| 41 | + |
| 42 | + * A method's signature is changed (including the number of parameters, the types of those parameters, 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 | + |
| 46 | + * A class/interface is removed or renamed, or is converted between a class and an interface |
| 47 | + |
| 48 | + * The inheritance tree is modified (other than simply being added to) |
| 49 | + |
| 50 | + |
| 51 | + If you are unsure, select "I don't know". **Breaking changes can only target unreleased major versions.** |
| 52 | + options: |
| 53 | + - "Yes" |
| 54 | + - "No" |
| 55 | + - "I don't know" |
| 56 | + validations: |
| 57 | + required: true |
| 58 | + - type: textarea |
| 59 | + id: what-do-you-want |
| 60 | + attributes: |
| 61 | + label: What are you requesting? |
| 62 | + description: > |
| 63 | + Explain what what you're requesting and why you're requesting it. Please add as much detail as you can. |
| 64 | + Feel free to give suggestions as to the form of the API you want - it doesn't need to be exact at this stage |
| 65 | + as we may help you refine your idea. |
| 66 | + validations: |
| 67 | + required: true |
| 68 | + |
0 commit comments