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 bug fix 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 bug fix, please follow the following steps:
|
|
|
|
|
|
|
|
1. Fill out the template in full.
|
|
|
|
This includes providing screenshots and a link to the original bug
|
|
|
|
report. If there isn't an existing bug report, we recommend opening a new
|
|
|
|
detailed bug report BEFORE opening your PR to fix it, else your PR may be
|
|
|
|
delayed or rejected without warning.
|
|
|
|
|
|
|
|
You can open a new bug report by following this link:
|
|
|
|
https://github.com/EssentialsX/Essentials/issues/new/choose
|
|
|
|
|
|
|
|
2. When linking logs or config files, do not attach them to the post!
|
|
|
|
Copy and paste any logs into https://gist.github.com/, then paste a
|
|
|
|
link to them in the relevant parts of the template. Do not use Hastebin
|
|
|
|
or Pastebin, as this can cause issues with future reviews.
|
2021-02-05 20:58:26 +01:00
|
|
|
|
|
|
|
DO NOT drag logs directly into this text box, as we cannot read these!
|
2020-10-23 01:19:04 +02:00
|
|
|
|
|
|
|
3. If you are fixing a performance issue, please include a link to a
|
|
|
|
Timings and/or profiler report, both before and after your PR.
|
|
|
|
|
|
|
|
4. If you are fixing a visual bug, such as in commands, please include
|
|
|
|
screenshots so that we can more easily review the proposed fix.
|
2021-02-05 20:58:26 +01:00
|
|
|
(You can drag screenshots into the bottom of the editor.)
|
2020-10-23 01:19:04 +02:00
|
|
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
### Information
|
|
|
|
|
|
|
|
<!--
|
|
|
|
Replace #nnnn with the number of the original issue. If this PR fixes
|
|
|
|
multiple issues, you should repeat the phrase "fixes #nnnn" for each issue.
|
|
|
|
-->
|
|
|
|
|
|
|
|
This PR fixes #nnnn.
|
|
|
|
|
|
|
|
### Details
|
|
|
|
|
|
|
|
**Proposed fix:**
|
|
|
|
<!-- Type a description of your proposed fix below this line. -->
|
|
|
|
|
|
|
|
|
|
|
|
**Environments tested:**
|
2021-02-05 20:58:26 +01:00
|
|
|
|
|
|
|
<!-- 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:**
|
|
|
|
<!--
|
|
|
|
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.
|
|
|
|
-->
|
2021-02-05 20:58:26 +01:00
|
|
|
|