diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index a2f6276c..00000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,28 +0,0 @@ -[download]: https://www.spigotmc.org/resources/tradeshop.32762/ - -## General Troubleshooting - -Hey there! Before you report a bug or suggest a new feature, - please make sure to follow these steps first! - -- [ ] I have checked for similar issues. -- [ ] I have updated to the [latest TradeShop version][download]. -- [ ] I have checked the branches or the maintainers' PRs for upcoming features/bug fixes. - - -## Template - -### Issue Type - -- [ ] Bug Report -- [ ] Feature Request - -### Description - -Replace this sentence with a description and include as many details as you think are needed to understand your issue. - -## Credits & Disclaimer - -This file contains parts that were taken from [the JDA project](https://github.com/DV8FromTheWorld/JDA). -We do **not** wish to take credit for those parts. -Everything is licensed under the [Apache License v2.0](https://github.com/SparklingComet/TradeShop/blob/master/LICENSE). diff --git a/.github/ISSUE_TEMPLATE/bug-or-incompatibility.yml b/.github/ISSUE_TEMPLATE/bug-or-incompatibility.yml new file mode 100644 index 00000000..169d3718 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-or-incompatibility.yml @@ -0,0 +1,91 @@ +name: Plugin Bug or Incompatibility with another Plugin +description: Report issues with plugin incompatbility or other behavior related issues. Not for config help or any errors, contact us on Discord for the former, and use the right issue template for the latter. +body: + - type: markdown + attributes: + value: | + Before reporting a bug here, please make sure you are on the latest version of TradeShop or another supported version. + Forks of TradeShop receive no support here. If you are using a fork, please make sure that this issue also happens when using TradeShop. + + - type: textarea + attributes: + label: Expected behavior + description: What you expected to see. + validations: + required: true + - type: textarea + attributes: + label: Observed/Actual behavior + description: What you actually saw. + validations: + required: true + - type: textarea + attributes: + label: Steps/models to reproduce + description: This may include a build schematic, a video, or detailed instructions to help reconstruct the issue. + validations: + required: true + - type: textarea + attributes: + label: Plugin list + description: All plugins running on the server. + validations: + required: true + - type: textarea + attributes: + label: TradeShop version and Minecraft version (CraftBukkit/Spigot/Paper/...) + description: | + Run `/version` and `/ts help` on your server and **paste** the full, unmodified output here. + "latest" is *not* a version; we require the actual output outputs so we can adequately track down the issue. + Additionally, do NOT provide a screenshot, you MUST paste the entire output. + Lastly, if you use a pre-release (DEV build), add the date and time of the release as well, as often many pre-releases share the same version tag. +
+ Example + + ``` + > version + [20:34:42 INFO]: This server is running Paper version git-Paper-540 (MC: 1.16.5) (Implementing API version 1.16.5-R0.1-SNAPSHOT) + [20:34:42 INFO]: Checking version, please wait... + [20:34:42 INFO]: Previous version: git-Paper-538 (MC: 1.16.5) + [20:34:42 INFO]: You are running the latest version + > ts help + [00:13:35] [Server thread/INFO]: + [00:13:35] [Server thread/INFO]: TradeShop 2.3.0-DEV by Lori00 & KillerOfPie + [00:13:35] [Server thread/INFO]: + [00:13:35] [Server thread/INFO]: /tradeshop Display help message + [00:13:35] [Server thread/INFO]: /ts help Display help message + [00:13:35] [Server thread/INFO]: /ts setup Display shop setup tutorial + [00:13:35] [Server thread/INFO]: /ts bugs Report bugs to the developers + [00:13:35] [Server thread/INFO]: /ts playerlevel If Internal Permissions is enable this allows the getting and setting of player permission levels. + [00:13:35] [Server thread/INFO]: /ts reload Reload configuration files + [00:13:35] [Server thread/INFO]: + ``` + +
+ validations: + required: true + + - type: checkboxes + attributes: + label: Agreements + description: Please agree to the following. + options: + - label: I have searched for and ensured there isn't already an open issue regarding this. + required: true + - label: My version of Minecraft and TradeShop are supported by the TradeShop Dev Team (when in doubt, first ask on the [Discord](https://discord.link/TradeShopPlugin)). + required: true + + - type: textarea + attributes: + label: Other + description: | + Please include other helpful information below. + The more information we receive, the quicker and more effective we can be at finding the solution to the issue. + validations: + required: false + + - type: markdown + attributes: + value: | + If you have filled in all the required information, submit the issue. We will reply as soon as possible so please check back frequently. + **Disclaimer:** Several parts of this document were taken from the [PaperMC](https://github.com/PaperMC/Paper) project, which holds the credit. diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 04a3b4e6..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve TradeShop -title: "[BUG]" -labels: bug, help wanted -assignees: '' - ---- - -[download]: https://www.spigotmc.org/resources/tradeshop.32762/ - -Explanation of the label system for Issues may be found [here][https://github.com/SparklingComet/TradeShop/wiki/Issue-&-Pull-Request-labels]. - -## General Troubleshooting - -Hey there! Before you report a bug, - please make sure to follow these steps first! - -- [ ] I have checked for similar issues. -- [ ] I have updated to the [latest TradeShop version][download]. -- [ ] I have checked the branches or the maintainers' PRs for upcoming bug fixes. - -### Description - -Replace this sentence with a description and include as many details as you think are needed to understand your issue, as well as any steps required to replicate the issue. - -### Console Error - -
- - - Replace this text with the error from your console. - -
- -## Credits & Disclaimer - -This file contains parts that were taken from [the JDA project](https://github.com/DV8FromTheWorld/JDA). -We do **not** wish to take credit for those parts. -Everything is licensed under the [Apache License v2.0](https://github.com/SparklingComet/TradeShop/blob/master/LICENSE). diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..d0ace5f7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: TradeShop Help [Discord] + url: https://discord.link/TradeShopPlugin + about: If you are having issues with the configuration or questions about the use of our plugin, join our Discord server. You can also talk to us to suggest new features! + - name: Plugin Discussion [SpigotMC] + url: https://www.spigotmc.org/threads/tradeshop.198419/ + about: Original discussion thread on SpigotMC.org. Please only post there if you do not wish to open a Discord account, as it is harder to conduct a fluent discussion in that medium. Discord is preferred. diff --git a/.github/ISSUE_TEMPLATE/console-error-or-stacktrace.yml b/.github/ISSUE_TEMPLATE/console-error-or-stacktrace.yml new file mode 100644 index 00000000..fcfb84ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/console-error-or-stacktrace.yml @@ -0,0 +1,93 @@ +name: Console error or Stacktrace +description: Report errors, warnings or scary stacktraces +body: + - type: markdown + attributes: + value: | + Before reporting an error here, please make sure you are on the latest version of TradeShop (both STABLE or DEV -- check [here](https://github.com/Tradeshop/TradeShop/releases) for DEV builds). + Forks of TradeShop receive no support here. If you are using a fork, please make sure that this error also happens when using the upstream TradeShop version. + Please DO NOT use this issue template if you do not see a stacktrace or any other kind of error message. Use a more appropriate issue template instead (when in doubt, ask on [Discord](https://discord.link/TradeShopPlugin)). + + - type: textarea + attributes: + label: Stack trace + description: | + We need all of the stack trace! Do not cut off parts of it no matter how long it is. Please do not use attachments. + If you prefer, you can use a paste site like https://paste.gg. Please only add more than one stacktrace if you are sure they are releated. Otherwise, open an issue for every stacktrace. + value: | + ``` + paste your stack trace or a paste.gg link here! + ``` + placeholder: Please don't remove the backticks; it makes your issue a lot harder to read! + validations: + required: true + - type: textarea + attributes: + label: Plugin list + description: All plugins running on the server. + validations: + required: true + - type: textarea + attributes: + label: Actions to reproduce (if known) + description: This may include a build schematic, a video, or detailed instructions to help reconstruct the issue. Anything helps! + validations: + required: false + - type: textarea + attributes: + label: TradeShop version and Minecraft version (CraftBukkit/Spigot/Paper/...) + description: | + Run `/version` and `/ts help` on your server and **paste** the full, unmodified output here. + "latest" is *not* a version; we require the actual output outputs so we can adequately track down the issue. + Additionally, do NOT provide a screenshot, you MUST paste the entire output. + Lastly, if you use a pre-release (DEV build), add the date and time of the release as well, as often many pre-releases share the same version tag. +
+ Example + + ``` + > version + [20:34:42 INFO]: This server is running Paper version git-Paper-540 (MC: 1.16.5) (Implementing API version 1.16.5-R0.1-SNAPSHOT) + [20:34:42 INFO]: Checking version, please wait... + [20:34:42 INFO]: Previous version: git-Paper-538 (MC: 1.16.5) + [20:34:42 INFO]: You are running the latest version + > ts help + [00:13:35] [Server thread/INFO]: + [00:13:35] [Server thread/INFO]: TradeShop 2.3.0-DEV by Lori00 & KillerOfPie + [00:13:35] [Server thread/INFO]: + [00:13:35] [Server thread/INFO]: /tradeshop Display help message + [00:13:35] [Server thread/INFO]: /ts help Display help message + [00:13:35] [Server thread/INFO]: /ts setup Display shop setup tutorial + [00:13:35] [Server thread/INFO]: /ts bugs Report bugs to the developers + [00:13:35] [Server thread/INFO]: /ts playerlevel If Internal Permissions is enable this allows the getting and setting of player permission levels. + [00:13:35] [Server thread/INFO]: /ts reload Reload configuration files + [00:13:35] [Server thread/INFO]: + ``` + +
+ validations: + required: true + + - type: checkboxes + attributes: + label: Agreements + description: Please agree to the following. + options: + - label: I have searched for and ensured there isn't already an open issue regarding this. + required: true + - label: My version of Minecraft and TradeShop are supported by the TradeShop Dev Team (when in doubt, first ask on the [Discord](https://discord.link/TradeShopPlugin)). + required: true + + - type: textarea + attributes: + label: Other + description: | + Please include other helpful information below, if any. + The more information we receive, the quicker and more effective we can be at finding the solution to the issue. + validations: + required: false + + - type: markdown + attributes: + value: | + If you have filled in all the required information, submit the issue. We will reply as soon as possible so please check back frequently. + **Disclaimer:** Several parts of this document were taken from the [PaperMC](https://github.com/PaperMC/Paper) project, which holds the credit. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 15710523..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for TradeShop -title: "[FEATURE]" -labels: feature, help wanted -assignees: KillerOfPie - ---- - -[download]: https://www.spigotmc.org/resources/tradeshop.32762/ - -Explanation of the label system for Issues may be found [here][https://github.com/SparklingComet/TradeShop/wiki/Issue-&-Pull-Request-labels]. - -## General Troubleshooting - -Hey there! Before you report a feature, - please make sure to follow these steps first! - -- [ ] I have checked for similar feature requests. -- [ ] I have checked for [planned feature requests][https://github.com/SparklingComet/TradeShop/projects]. -- [ ] I have checked the branches or the maintainers' PRs for upcoming added features. - -### Description - -Replace this sentence with a description and include as many details as you think are needed to understand your request. - -## Credits & Disclaimer - -This file contains parts that were taken from [the JDA project](https://github.com/DV8FromTheWorld/JDA). -We do **not** wish to take credit for those parts. -Everything is licensed under the [Apache License v2.0](https://github.com/SparklingComet/TradeShop/blob/master/LICENSE). diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..1e0447b0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,52 @@ +name: Feature Request +description: Suggest an idea for Paper +body: + - type: markdown + attributes: + value: | + Thank you for filling out a feature request for the TradeShop plugin! Please be as detailed as possible so that we may consider and review the request easier. + We ask that you search all the issues to avoid a duplicate feature request. If one exists, please reply to that issue instead if you have anything to add. + Before requesting a new feature, please make sure you are using the latest version and that the feature you are requesting is not already part of the plugin. + + - type: textarea + attributes: + label: Is your feature request related to a problem? + description: Please give some context for this request. Why do you want it added? + validations: + required: true + - type: textarea + attributes: + label: Describe the solution you'd like. + description: A clear and concise description of what you want. + validations: + required: true + - type: textarea + attributes: + label: Describe alternatives you've considered. + description: List any alternatives (if any) you might have tried to get the feature you want. + validations: + required: true + + - type: checkboxes + attributes: + label: Agreements + description: Please agree to the following. + options: + - label: I have searched for and ensured there isn't already an open issue regarding this. + required: true + - label: I have ensured the feature I'm requesting isn't already in the latest supported TradeShop build. + required: true + - label: I have asked the Developers and they have confirmed that it is not already in development. + + - type: textarea + attributes: + label: Other + description: Add any other context or screenshots about the feature request below. + validations: + required: false + + - type: markdown + attributes: + value: | + If you have filled in all the required information, submit the issue. We will reply as soon as possible so please check back frequently. + **Disclaimer:** Several parts of this document were taken from the [PaperMC](https://github.com/PaperMC/Paper) project, which holds the credit. diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md deleted file mode 100644 index bca78d98..00000000 --- a/.github/ISSUE_TEMPLATE/other.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -name: Other -about: If you are not sure or you don't think one of the other two options do not - match. -title: "[OTHER]" -labels: help wanted -assignees: '' - ---- - -[download]: https://www.spigotmc.org/resources/tradeshop.32762/ - -Explanation of the label system for Issues may be found [here][https://github.com/SparklingComet/TradeShop/wiki/Issue-&-Pull-Request-labels]. - -## General Troubleshooting - -Hey there! Before you report a bug or suggest a new feature, - please make sure to follow these steps first! - -- [ ] I have checked for similar issues/requests. -- [ ] I have updated to the [latest TradeShop version][download]. -- [ ] I have checked for [planned feature requests][https://github.com/SparklingComet/TradeShop/projects]. -- [ ] I have checked the branches or the maintainers' PRs for upcoming features/bug fixes. - -### Issue Type - -- [ ] Bug Report -- [ ] Feature Request - -### Description - -Replace this sentence with a description and include as many details as you think are needed to understand your issue. - -### Console Error - -
- - - Replace this text with the error from your console if there is one. - -
- -## Credits & Disclaimer - -This file contains parts that were taken from [the JDA project](https://github.com/DV8FromTheWorld/JDA). -We do **not** wish to take credit for those parts. -Everything is licensed under the [Apache License v2.0](https://github.com/SparklingComet/TradeShop/blob/master/LICENSE). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2a935ba7..000d3569 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,8 +2,8 @@ ## Pull Request Etiquette -There are several guidelines you should follow in order for your - Pull Request to be merged. +There are several guidelines you should follow in order for your Pull Request to be merged. +Replace `[ ]` with `[x]` to cross the checkbox. - [ ] I have checked the PRs for upcoming features/bug fixes. - [ ] I have read the [contributing guidelines][contributing]. @@ -12,8 +12,7 @@ There are several guidelines you should follow in order for your If you find yourself having an overwhelming amount of commits, you can **rebase** your branch. -## Template +## Changes -### Pull Request +_Replace this sentence with a description of che changes introduced by this PR._ -Replace this sentence with general description of what your Pull Request does.