2021-02-05 20:58:26 +01:00
|
|
|
<!--
|
2020-10-23 01:19:04 +02:00
|
|
|
|
2021-02-05 20:58:26 +01:00
|
|
|
EssentialsX feature submission guide
|
|
|
|
====================================
|
2020-10-23 01:19:04 +02:00
|
|
|
|
|
|
|
NOTE: Failure to fill out this template properly may result in your PR being
|
|
|
|
delayed or ignored without warning.
|
|
|
|
|
2021-02-05 20:58:26 +01:00
|
|
|
NOTE: Don't type between any arrows in the template, as this text will be
|
|
|
|
hidden. This includes this header block and any other explanation text
|
|
|
|
blocks.
|
2020-10-23 01:19:04 +02:00
|
|
|
|
|
|
|
Want to discuss your PR before submitting it? Join the EssentialsX Development
|
|
|
|
server: https://discord.gg/CUN7qVb
|
|
|
|
|
2021-02-05 20:58:26 +01:00
|
|
|
|
|
|
|
EssentialsX is GPL
|
|
|
|
------------------
|
|
|
|
|
2020-10-23 01:19:04 +02:00
|
|
|
By contributing to EssentialsX, you agree to license your code under the
|
|
|
|
GNU General Public License version 3, which can be found at the link below:
|
|
|
|
https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE
|
|
|
|
|
2021-02-05 20:58:26 +01:00
|
|
|
|
|
|
|
Instructions
|
|
|
|
------------
|
|
|
|
|
2020-10-23 01:19:04 +02:00
|
|
|
If you are submitting a new feature, please follow the following steps:
|
|
|
|
|
|
|
|
1. Fill out the template in full.
|
|
|
|
This includes providing screenshots and a link to the original feature
|
|
|
|
request. If there isn't an existing feature request, we strongly
|
|
|
|
recommend opening a new feature request BEFORE opening your PR to
|
|
|
|
implement it, as this allows us to review whether we're likely to accept
|
|
|
|
your feature in advance, and also allows us to discuss possible
|
|
|
|
implementations for the feature. If there is no associated feature
|
|
|
|
request, your PR may be delayed or rejected without warning.
|
|
|
|
|
|
|
|
You can open a new feature request by following this link:
|
|
|
|
https://github.com/EssentialsX/Essentials/issues/new/choose
|
|
|
|
|
|
|
|
2. If you are fixing a performance issue, please use the "Bug fix" PR template
|
|
|
|
instead. The "bug fix" template is better suited to performance issues.
|
|
|
|
|
|
|
|
3. Include a demonstration.
|
|
|
|
If you are adding commands, please provide screenshots and/or a video
|
|
|
|
demonstration of the feature. Similarly, if you are adding a new API,
|
|
|
|
please include a link to example code that takes advantage of your
|
|
|
|
proposed API. This will aid us in reviewing PRs and speed up the process
|
|
|
|
significantly.
|
|
|
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
### Information
|
|
|
|
|
|
|
|
<!--
|
|
|
|
Replace #nnnn with the number of the original issue. If this PR implements
|
|
|
|
features from multiple issues, you should repeat the phrase "closes #nnnn"
|
|
|
|
for each issue.
|
|
|
|
-->
|
|
|
|
|
|
|
|
This PR closes #nnnn.
|
|
|
|
|
|
|
|
### Details
|
|
|
|
|
2021-02-05 20:58:26 +01:00
|
|
|
**Proposed feature:**
|
2020-10-23 01:19:04 +02:00
|
|
|
<!-- Type a description of your proposed feature below this line. -->
|
|
|
|
|
2021-02-05 20:58:26 +01:00
|
|
|
|
|
|
|
**Environments tested:**
|
|
|
|
|
|
|
|
<!-- Type the OS you have used below. -->
|
|
|
|
OS:
|
|
|
|
|
2021-05-21 13:15:05 +02:00
|
|
|
<!-- Type the JDK version (from java -version) you have used below. -->
|
2021-02-05 20:58:26 +01:00
|
|
|
Java version:
|
|
|
|
|
2020-10-23 01:19:04 +02:00
|
|
|
<!--
|
2021-02-05 20:58:26 +01:00
|
|
|
Put an "x" inside the boxes for the server software you have tested this
|
|
|
|
bug fix on. If this feature does not apply to a server, strike through the server software using ~~strikethrough~~. If you have tested on other
|
|
|
|
environments, add a new line with relevant details.
|
2020-10-23 01:19:04 +02:00
|
|
|
-->
|
2021-02-05 20:58:26 +01:00
|
|
|
- [ ] Most recent Paper version (1.XX.Y, git-Paper-BUILD)
|
|
|
|
- [ ] CraftBukkit/Spigot/Paper 1.12.2
|
|
|
|
- [ ] CraftBukkit 1.8.8
|
2020-10-23 01:19:04 +02:00
|
|
|
|
|
|
|
|
|
|
|
**Demonstration:**
|
|
|
|
<!--
|
2021-02-05 20:58:26 +01:00
|
|
|
Below this block, include screenshots/log snippets from before and after as
|
|
|
|
necessary. If you have created or used a test case plugin, please link to a
|
|
|
|
download of the plugin, source code and exact version used where possible.
|
2020-10-23 01:19:04 +02:00
|
|
|
-->
|