diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 4aa80c18d..4927b20ea 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,10 +1,10 @@ # Currently used patreon: EssentialsX ko_fi: essentialsx +github: EssentialsX +open_collective: EssentialsX # Currently not used -#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] -#open_collective: # Replace with a single Open Collective username #tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel #community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry #liberapay: # Replace with a single Liberapay username diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index b2bce892e..d3293af95 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,20 @@ blank_issues_enabled: false contact_links: - - name: MOSS Discord Server + - name: View common issues + url: https://github.com/EssentialsX/Essentials/issues/3956 + about: Check the list of known common issues to see if it solves your problem. + - name: Check past help requests + url: https://github.com/EssentialsX/Essentials/discussions/categories/q-a + about: Visit the Q&A forum to search for previous help requests. + - name: Check past feature suggestions + url: https://github.com/EssentialsX/Essentials/discussions/categories/ideas-and-feature-suggestions + about: Visit the Feature Suggestions forum to view and discuss existing feature suggestions. + - name: Create help request + url: https://github.com/EssentialsX/Essentials/discussions/new?category=q-a + about: Create a support ticket to get help from developers. + - name: Suggest a feature + url: https://github.com/EssentialsX/Essentials/discussions/new?category=ideas-and-feature-suggestions + about: Suggest new features for EssentialsX! + - name: Get help from the community on Discord url: https://discord.gg/casfFyh - about: Need help with using EssentialsX? Join the MOSS Discord server for help. + about: Join the MOSS Discord for community-powered EssentialsX support! diff --git a/.github/ISSUE_TEMPLATE/help.md b/.github/ISSUE_TEMPLATE/help.md deleted file mode 100644 index d46a29e87..000000000 --- a/.github/ISSUE_TEMPLATE/help.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -name: Help! -about: Encountered a problem with EssentialsX? Not sure how to fix it? -labels: 'type: question' - ---- - - - -### Information - -**Full output of `/ess version`:** - -``` - -``` - -**Server startup log:** - - - -**EssentialsX config:** - - - -### Help request - -**Problem:** - - -**What I have tried:** - - -**Console stack trace:** - -``` - -``` - -**Screenshots:** - diff --git a/.github/ISSUE_TEMPLATE/report-a-bug.md b/.github/ISSUE_TEMPLATE/report-a-bug.md deleted file mode 100644 index 3583fd794..000000000 --- a/.github/ISSUE_TEMPLATE/report-a-bug.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -name: Report a bug -about: Report an EssentialsX bug. Only use this if you're 100% sure there's something wrong with EssentialsX - otherwise, try "Help!". -labels: 'bug: unconfirmed' - ---- - - - -### Information - -**Full output of `/ess version`:** - -``` - -``` - -**Server startup log:** - - - -**EssentialsX config:** - - - -### Details - -**Description:** - - -**Steps to reproduce:** - - -**Expected behavior:** - - -**Console stack trace:** - -``` - -``` - -**Screenshots:** - diff --git a/.github/ISSUE_TEMPLATE/report-a-bug.yml b/.github/ISSUE_TEMPLATE/report-a-bug.yml new file mode 100644 index 000000000..a4a24ffec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/report-a-bug.yml @@ -0,0 +1,82 @@ +name: Report a bug +about: Report a bug in EssentialsX. +labels: 'bug: unconfirmed' +inputs: +- type: description + attributes: + value: | + Thanks for taking the time to report an EssentialsX bug! Fill out the form below to provide us with info to help fix the bug. + Only use this if you're 100% sure you've found a bug and can reproduce it. If you're looking for general help with EssentialsX, try the Q&A forum or MOSS Discord server. +- type: multi_select + attributes: + label: Type of bug + description: What type of bug is this? Choose all that apply. + required: true + choices: + - Performance issue or memory leak + - Data loss + - Exploit + - Compatibility issue + - Error in console + - Other unexpected behaviour + +- type: textarea + attributes: + label: "`/ess version` output" + description: Run `/ess version` in the console, then copy and paste the full output of the command into this box. + required: true +- type: input + attributes: + label: Server startup log + description: Upload your server startup log (from the start of `latest.log` up to where it says "Done!") to either https://paste.gg or https://gist.github.com, save and then paste the link in this box. + required: true + placeholder: "Example: https://paste.gg/p/anonymous/109dd6a10a734a3aa430d5a351ea5210" +- type: input + attributes: + label: EssentialsX config files + description: Upload your EssentialsX `config.yml` (and any other relevant files like `kits.yml`) to either https://paste.gg or https://gist.github.com, save and then paste the link in this box. If you included those files in the same paste as your startup log, paste the same link here. + required: true + placeholder: "Example: https://paste.gg/p/anonymous/109dd6a10a734a3aa430d5a351ea5210" +- type: input + attributes: + label: Error log (if applicable) + description: If you are reporting a console error, upload any relevant log excerpts to either https://paste.gg or https://gist.github.com, save and the paste the link in this box. If you included those files in the same paste as your startup log, paste the same link here. + placeholder: "Example: https://paste.gg/p/anonymous/109dd6a10a734a3aa430d5a351ea5210" + +- type: textarea + attributes: + label: Bug description + description: Describe roughly what the bug is here. + required: true + placeholder: | + Example: "When running /nuke after putting everyone into adventure mode, there aren't any explosions..." +- type: textarea + attributes: + label: Steps to reproduce + description: Provide an example of how to trigger the bug. + required: true + placeholder: | + Example: + 1. Have at least 3 people online + 2. Run `/gma *` to put everyone into adventure mode + 3. Run `/nuke` +- type: textarea + attributes: + label: Expected behaviour + description: Explain what you should expect to happen. + required: true + placeholder: | + Example: "Everything should explode!" +- type: textarea + attributes: + label: Actual behaviour + description: Explain what actually happens. + required: true + placeholder: | + Example: "Everything doesn't explode :(" + +- type: description + attributes: + value: | + In the text box below, you can attach any relevant screenshots, files and links to Timings/spark profiler reports. You can also include a link to a heapdump if necessary, but please make sure you don't include any private player data in the heapdump. + diff --git a/.github/ISSUE_TEMPLATE/request-a-feature.md b/.github/ISSUE_TEMPLATE/request-a-feature.md deleted file mode 100644 index fcda835c3..000000000 --- a/.github/ISSUE_TEMPLATE/request-a-feature.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: Request a feature -about: Suggest a feature you want to see in EssentialsX! -labels: 'type: enhancement' - ---- - - - -### Feature request - -**Feature description:** - - -**How the feature is useful:** - diff --git a/.github/PULL_REQUEST_TEMPLATE/bug-fix.md b/.github/PULL_REQUEST_TEMPLATE/bug-fix.md index 75982a91c..3a95c920e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/bug-fix.md +++ b/.github/PULL_REQUEST_TEMPLATE/bug-fix.md @@ -1,24 +1,30 @@ ---- -name: Bug fix -about: Use this if your PR fixes a bug in EssentialsX. -labels: 'type: bugfix' ---- + @@ -61,17 +68,21 @@ This PR fixes #nnnn. **Environments tested:** - -- [ ] [Latest](https://papermc.io/downloads) Paper Version (any OS, any Java 8+ version) -- [ ] CraftBukkit/Spigot/Paper 1.12.2 (any OS, any Java 8+ version) -- [ ] CraftBukkit 1.8.8 (any OS, any Java 8+ version) + +OS: + + +Java version: + + +- [ ] Most recent Paper version (1.XX.Y, git-Paper-BUILD) +- [ ] CraftBukkit/Spigot/Paper 1.12.2 +- [ ] CraftBukkit 1.8.8 **Demonstration:** @@ -80,3 +91,4 @@ This PR fixes #nnnn. 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. --> + diff --git a/.github/PULL_REQUEST_TEMPLATE/new-feature.md b/.github/PULL_REQUEST_TEMPLATE/new-feature.md index e1b9d263d..837eb1e7d 100644 --- a/.github/PULL_REQUEST_TEMPLATE/new-feature.md +++ b/.github/PULL_REQUEST_TEMPLATE/new-feature.md @@ -1,24 +1,30 @@ ---- -name: Feature addition -about: Use this if your PR adds a new feature to EssentialsX. -labels: 'type: enhancement' ---- + -**Environments tested:** - -- [ ] [Latest](https://papermc.io/downloads) Paper Version (any OS, any Java 8+ version) -- [ ] CraftBukkit/Spigot/Paper 1.12.2 (any OS, any Java 8+ version) -- [ ] CraftBukkit 1.8.8 (any OS, any Java 8+ version) +**Environments tested:** + + +OS: + + +Java version: + + +- [ ] Most recent Paper version (1.XX.Y, git-Paper-BUILD) +- [ ] CraftBukkit/Spigot/Paper 1.12.2 +- [ ] CraftBukkit 1.8.8 + **Demonstration:** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..0ae823883 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,10 @@ +You need to select a pull request template! + +If you're adding a new feature, copy and paste the following parameter at the end of the URL: + ?template=new-feature.md + +If you're fixing a bug, copy and paste the following parameter at the end of the URL: + ?template=bug-fix.md + +For more information about contributing to EssentialsX, see CONTRIBUTING.md: + https://github.com/EssentialsX/Essentials/blob/2.x/CONTRIBUTING.md