Upstream/Essentials
1
0
Fork 0
mirror of https://github.com/EssentialsX/Essentials.git synced 2024-12-23 01:27:40 +01:00
Code Issues Projects Releases Wiki Activity

Update issue chooser with forms and Discussions links (#3936)

Browse Source 
Co-authored-by: triagonal <10545540+triagonal@users.noreply.github.com>
Co-authored-by: Josh Roy <10731363+JRoy@users.noreply.github.com>

This commit:
- Introduces a bug reporting form
- Moves feature requests and support requests to Discussions
- Adds a default PR template instructing people to use the correct template
- Adds GitHub Sponsors and Open Collective to the Sponsor button
This commit is contained in:
MD 2021-02-05 19:58:26 +00:00 committed by GitHub
parent 401fc4d2eb
commit 9ce839c9d8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 178 additions and 269 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/FUNDING.yml vendored
View File

@ -1,10 +1,10 @@
# Currently used # Currently used
patreon: EssentialsX patreon: EssentialsX
ko_fi: essentialsx ko_fi: essentialsx
github: EssentialsX
open_collective: EssentialsX
# Currently not used # 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 #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 #community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
#liberapay: # Replace with a single Liberapay username #liberapay: # Replace with a single Liberapay username

19
.github/ISSUE_TEMPLATE/config.yml vendored
View File

@ -1,5 +1,20 @@
blank_issues_enabled: false blank_issues_enabled: false
contact_links: 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 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!

86
.github/ISSUE_TEMPLATE/help.md vendored
View File

@ -1,86 +0,0 @@
---
name: Help!
about: Encountered a problem with EssentialsX? Not sure how to fix it?
labels: 'type: question'
---
<!-- EssentialsX help request guide
NOTE: Failure to fill out this template properly may result in your issue being
delayed or ignored.
Don't type between any arrows in the template, as this text will be hidden.
This includes this header block and any other explanatory text blocks.
Want faster support? Come join our Discord server to get help from both
developers and community members: https://discord.gg/F7gexAQ
If you're happy to wait (or you were sent here from Discord), read on:
1. Check the Common Issues page.
Read through the wiki page to see if you've encountered a regular issue:
https://essentialsx.net/wiki/Common-Issues.html
2. Fill out the template.
Run the commands in the console. Don't just put "latest" as a version, or
we will ignore it. This will help us understand what problem you've
encountered and help us find a solution.
3. 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 when trying to solve issues in the
future.
**DO NOT drag logs into this text box!**
4. If you are encountering a performance issue, please include a link to a
Timings and/or profiler report.
-->
### Information
**Full output of `/ess version`:**
<!--
Run /ess version in the console, then paste the full output of the command
between the ```s.
-->
```
```
**Server startup log:**
<!--
Restart your server and upload `logs/latest.log` to
https://gist.github.com/. You may redact sensitive data (such as IP
addresses), but you should make it clear what data was removed. Once
uploaded, paste the link below this block.
-->
**EssentialsX config:**
<!--
Upload `plugins/Essentials/config.yml` (and other config files if relevant)
to https://gist.github.com/ then paste the link below this block.
-->
### Help request
**Problem:**
<!-- What problem did you encounter? Type below this line. -->
**What I have tried:**
<!-- What have you tried so far? Type below this line. -->
**Console stack trace:**
<!--
If you are reporting an error in the console, paste it between the ```s.
-->
```
```
**Screenshots:**
<!-- If relevant, include any screenshots or a video below this line. -->

83
.github/ISSUE_TEMPLATE/report-a-bug.md vendored
View File

@ -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'
---
<!-- EssentialsX bug reporting guide
NOTE: Failure to fill out this template properly may result in your issue being
delayed or ignored.
Don't type between any arrows in the template, as this text will be hidden.
This includes this header block and any other explanatory text blocks.
If you are reporting a bug, please follow the following steps:
1. Fill out the template in full.
Run the commands in the console. Don't just put "latest" as a version,
or we will ignore it.
2. When linking 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. Avoid using
Hastebin or Pastebin, as this makes providing support more difficult.
**DO NOT drag files into this text box!**
3. If you are reporting a performance issue, please include a link to a
Timings and/or profiler report.
4. If you are reporting a bug with commands or something else in-game,
please include screenshots to help us diagnose the problem.
-->
### Information
**Full output of `/ess version`:**
<!--
Run /ess version in the console, then paste the full output of the command
between the ```s.
-->
```
```
**Server startup log:**
<!--
Restart your server and upload `logs/latest.log` to
https://gist.github.com/. You may redact sensitive data (such as IP
addresses), but you should make it clear what data was removed. Once
uploaded, paste the link below this block.
-->
**EssentialsX config:**
<!--
Upload `plugins/Essentials/config.yml` (and other config files if relevant)
to https://gist.github.com/ then paste the link below this block.
-->
### Details
**Description:**
<!-- What is the bug? Type a brief summary below this line. -->
**Steps to reproduce:**
<!-- How did you cause it? Describe what you did to cause the bug below. -->
**Expected behavior:**
<!-- What did you expect to happen? Type below this line. -->
**Console stack trace:**
<!--
If you are encountering an error in the console, paste it between the ```s.
-->
```
```
**Screenshots:**
<!-- If necessary, include screenshots or a video below this line. -->

82
.github/ISSUE_TEMPLATE/report-a-bug.yml vendored Normal file
View File

@ -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.

52
.github/ISSUE_TEMPLATE/request-a-feature.md vendored
View File

@ -1,52 +0,0 @@
---
name: Request a feature
about: Suggest a feature you want to see in EssentialsX!
labels: 'type: enhancement'
---
<!-- EssentialsX feature request guide
NOTE: Failure to fill out this template properly may result in your issue being
delayed or ignored.
Don't type between any arrows in the template, as this text will be hidden.
This includes this header block and any other explanatory text blocks.
Not sure if your feature fits in EssentialsX? Feel free to ask on our Discord
server: https://discord.gg/F7gexAQ
If you have a feature suggestion for EssentialsX, read the following tips:
1. Fill out the template.
This will help us understand what you're requesting and why you want us
to add it.
2. Keep it simple.
Make sure it's easy to understand what you're requesting. A good way is
to keep it to one request per GitHub issue, as we can then easily track
feature requests.
3. Check whether it has already been asked or added.
You can search the issue tracker to see if your feature has already been
requested at https://github.com/EssentialsX/Essentials/issues. You can
also check the changelogs to see if the feature was recently added:
https://github.com/EssentialsX/Essentials/releases
4. Ask yourself: "Does this belong in EssentialsX?"
There are lots of features that we reject because most servers won't
need or use them. If your feature is very specific or already exists in
another plugin, it might not be a good fit for EssentialsX.
-->
### Feature request
**Feature description:**
<!-- What feature are you suggesting? Type below this line. -->
**How the feature is useful:**
<!--
How is the feature useful to players, server owners and/or developers?
Type below this block.
-->

52
.github/PULL_REQUEST_TEMPLATE/bug-fix.md vendored
View File

@ -1,24 +1,30 @@
--- <!--
name: Bug fix
about: Use this if your PR fixes a bug in EssentialsX.
labels: 'type: bugfix'
---
<!-- EssentialsX bug fix submission guide EssentialsX bug fix submission guide
====================================
NOTE: Failure to fill out this template properly may result in your PR being NOTE: Failure to fill out this template properly may result in your PR being
delayed or ignored without warning. delayed or ignored without warning.
Don't type between any arrows in the template, as this text will be hidden. NOTE: Don't type between any arrows in the template, as this text will be
This includes this header block and any other explanatory text blocks. hidden. This includes this header block and any other explanation text
blocks.
Want to discuss your PR before submitting it? Join the EssentialsX Development Want to discuss your PR before submitting it? Join the EssentialsX Development
server: https://discord.gg/CUN7qVb server: https://discord.gg/CUN7qVb
EssentialsX is GPL
------------------
By contributing to EssentialsX, you agree to license your code under the 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: GNU General Public License version 3, which can be found at the link below:
https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE
Instructions
------------
If you are submitting a bug fix, please follow the following steps: If you are submitting a bug fix, please follow the following steps:
1. Fill out the template in full. 1. Fill out the template in full.
@ -34,14 +40,15 @@ If you are submitting a bug fix, please follow the following steps:
Copy and paste any logs into https://gist.github.com/, then paste a 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 link to them in the relevant parts of the template. Do not use Hastebin
or Pastebin, as this can cause issues with future reviews. or Pastebin, as this can cause issues with future reviews.
**DO NOT drag logs into this text box!**
DO NOT drag logs directly into this text box, as we cannot read these!
3. If you are fixing a performance issue, please include a link to a 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. 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 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. screenshots so that we can more easily review the proposed fix.
(You may drag screenshots directly into this box.) (You can drag screenshots into the bottom of the editor.)
--> -->
@ -61,17 +68,21 @@ This PR fixes #nnnn.
**Environments tested:** **Environments tested:**
<!--
Below this line, put an "x" inside the box for the environments you have
tested this bug fix on, and if relevant alter the OS and Java version
accordingly. If this feature does not apply to an environment, strike
through the environment using ~~strikethrough~~. If you have tested on
other environments, add a new line with relevant details.
-->
- [ ] [Latest](https://papermc.io/downloads) Paper Version (any OS, any Java 8+ version) <!-- Type the OS you have used below. -->
- [ ] CraftBukkit/Spigot/Paper 1.12.2 (any OS, any Java 8+ version) OS:
- [ ] CraftBukkit 1.8.8 (any OS, any Java 8+ version)
<!-- Type the JDK version (from java --version) you have used below. -->
Java version:
<!--
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.
-->
- [ ] Most recent Paper version (1.XX.Y, git-Paper-BUILD)
- [ ] CraftBukkit/Spigot/Paper 1.12.2
- [ ] CraftBukkit 1.8.8
**Demonstration:** **Demonstration:**
@ -80,3 +91,4 @@ This PR fixes #nnnn.
necessary. If you have created or used a test case plugin, please link to a 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. download of the plugin, source code and exact version used where possible.
--> -->

59
.github/PULL_REQUEST_TEMPLATE/new-feature.md vendored
View File

@ -1,24 +1,30 @@
--- <!--
name: Feature addition
about: Use this if your PR adds a new feature to EssentialsX.
labels: 'type: enhancement'
---
<!-- EssentialsX feature submission guide EssentialsX feature submission guide
====================================
NOTE: Failure to fill out this template properly may result in your PR being NOTE: Failure to fill out this template properly may result in your PR being
delayed or ignored without warning. delayed or ignored without warning.
Don't type between any arrows in the template, as this text will be hidden. NOTE: Don't type between any arrows in the template, as this text will be
This includes this header block and any other explanatory text blocks. hidden. This includes this header block and any other explanation text
blocks.
Want to discuss your PR before submitting it? Join the EssentialsX Development Want to discuss your PR before submitting it? Join the EssentialsX Development
server: https://discord.gg/CUN7qVb server: https://discord.gg/CUN7qVb
EssentialsX is GPL
------------------
By contributing to EssentialsX, you agree to license your code under the 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: GNU General Public License version 3, which can be found at the link below:
https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE https://github.com/EssentialsX/Essentials/blob/2.x/LICENSE
Instructions
------------
If you are submitting a new feature, please follow the following steps: If you are submitting a new feature, please follow the following steps:
1. Fill out the template in full. 1. Fill out the template in full.
@ -57,26 +63,31 @@ This PR closes #nnnn.
### Details ### Details
**Proposed feature** **Proposed feature:**
<!-- Type a description of your proposed feature below this line. --> <!-- Type a description of your proposed feature below this line. -->
**Environments tested:**
<!--
Below this block, put an "x" inside the box for the environments you have
tested this bug fix on, and if relevant alter the OS and Java version
accordingly. If this feature does not apply to an environment, strike
through the environment using ~~strikethrough~~. If you have tested on
other environments, add a new line with relevant details.
-->
- [ ] [Latest](https://papermc.io/downloads) Paper Version (any OS, any Java 8+ version) **Environments tested:**
- [ ] CraftBukkit/Spigot/Paper 1.12.2 (any OS, any Java 8+ version)
- [ ] CraftBukkit 1.8.8 (any OS, any Java 8+ version) <!-- Type the OS you have used below. -->
OS:
<!-- Type the JDK version (from java --version) you have used below. -->
Java version:
<!--
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.
-->
- [ ] Most recent Paper version (1.XX.Y, git-Paper-BUILD)
- [ ] CraftBukkit/Spigot/Paper 1.12.2
- [ ] CraftBukkit 1.8.8
**Demonstration:** **Demonstration:**
<!-- <!--
Below this block, include screenshots/code snippets from before and after Below this block, include screenshots/log snippets from before and after as
as necessary. If you have created or used a test case plugin, please link necessary. If you have created or used a test case plugin, please link to a
to a download of the plugin, source code and exact version used where download of the plugin, source code and exact version used where possible.
possible.
--> -->

10
.github/pull_request_template.md vendored Normal file
View File

@ -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