mirror of
https://github.com/CitizensDev/Citizens2.git
synced 2024-11-21 18:15:51 +01:00
Improve issue template using Issue forms (#2684)
This commit is contained in:
Andre_601
GitHub
parent
eb8ac56b65
commit
e7d3a95981
89
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
89
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,89 @@
|
||||
name: Bug Report
|
||||
description: Use this form to report a bug with Citizens.
|
||||
|
||||
body:
|
||||
- type: 'markdown'
|
||||
attributes:
|
||||
value: |-
|
||||
## DO NOT IGNORE
|
||||
Please fill out all required fields the way they are described as.
|
||||
**Not following the issue form will get it closed automatically!**
|
||||
|
||||
----
|
||||
|
||||
### Section 1) Version Infos
|
||||
Include the outputs of `/version` and `/version Citizens` in the respective fields.
|
||||
- type: 'textarea'
|
||||
attributes:
|
||||
label: '`/version` output'
|
||||
description: 'Include the **complete** output of the `/version` command here.'
|
||||
placeholder: 'This server is running ...'
|
||||
render: txt
|
||||
validations:
|
||||
required: true
|
||||
- type: 'textarea'
|
||||
attributes:
|
||||
label: '`/version Citizens` output'
|
||||
description: 'Include the **complete** output of the `/version Citizens` command here.'
|
||||
placeholder: 'Citizens Version ...'
|
||||
render: txt
|
||||
validations:
|
||||
required: true
|
||||
- type: 'markdown'
|
||||
attributes:
|
||||
value: |-
|
||||
----
|
||||
|
||||
### Section 2) Log and Configuration files
|
||||
Provide your server's latest log file, the configuration file (`config.yml`) and the `saves.yml` file of Citizens.
|
||||
- type: 'input'
|
||||
attributes:
|
||||
label: 'Log file'
|
||||
description: 'Upload your server''s latest.log to https://paste.denizenscript.com/New/Log and paste the generated URL in the field below.'
|
||||
placeholder: 'https://paste.denizenscript.com/View/...'
|
||||
validations:
|
||||
required: true
|
||||
- type: 'input'
|
||||
attributes:
|
||||
label: 'config.yml'
|
||||
description: 'Upload the config.yml to https://paste.denizenscript.com/New/Log and paste the generated URL in the field below.'
|
||||
placeholder: 'https://paste.denizenscript.com/View/...'
|
||||
validations:
|
||||
required: true
|
||||
- type: 'input'
|
||||
attributes:
|
||||
label: 'saves.yml'
|
||||
description: 'Upload the saves.yml of Citizens to https://paste.denizenscript.com/New/Log and paste the generated URL in the field below.'
|
||||
placeholder: 'https://paste.denizenscript.com/View/...'
|
||||
validations:
|
||||
required: true
|
||||
- type: 'markdown'
|
||||
attributes:
|
||||
value: |-
|
||||
----
|
||||
|
||||
### Section 3) Performance Report
|
||||
**This section is only required when having Performance issues!**
|
||||
|
||||
Include a report from a profiler such as Spark [[Download](https://www.spigotmc.org/resources/57242/)].
|
||||
Spigot Timings alone are NOT allowed, but can be included alongside another profiler report.
|
||||
- type: 'input'
|
||||
attributes:
|
||||
label: 'Profiler report'
|
||||
description: 'Post the Report from a profiler such as Spark here.'
|
||||
placeholder: 'https://spark.lucko.me/...'
|
||||
- type: 'markdown'
|
||||
attributes:
|
||||
value: |-
|
||||
----
|
||||
|
||||
### Section 4) Information
|
||||
Give a detailed explanation about your current issue.
|
||||
When possible, include steps to reproduce it reliably.
|
||||
- type: 'textarea'
|
||||
attributes:
|
||||
label: 'Description'
|
||||
description: 'Give a detailed description of the issue you encounter.'
|
||||
placeholder: 'When doing ... does Citizens do ...'
|
||||
validations:
|
||||
required: true
|
||||
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
14
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Wiki
|
||||
about: 'Please visit the Citizens Wiki before reporting issues.'
|
||||
url: 'https://wiki.citizensnpcs.co/Citizens_Wiki'
|
||||
- name: Citizens API
|
||||
about: 'Documentation about the API of Citizens.'
|
||||
url: 'https://wiki.citizensnpcs.co/API'
|
||||
- name: Development Builds
|
||||
about: 'Dev builds of Citizens. Always make backups before updating.'
|
||||
url: 'https://ci.citizensnpcs.co/job/Citizens2/'
|
||||
- name: Denizen and Citizens Discord
|
||||
about: 'Ask questions here!'
|
||||
url: 'https://discord.gg/Q6pZGSR'
|
||||
58
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
58
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,58 @@
|
||||
name: Feature Request
|
||||
description: Suggest a new feature and/or improvement for Citizens.
|
||||
|
||||
body:
|
||||
- type: 'markdown'
|
||||
attributes:
|
||||
value: |-
|
||||
## DO NOT IGNORE
|
||||
Please fill out all required fields the way they are described as.
|
||||
**Not following the issue form will get it closed automatically!**
|
||||
|
||||
----
|
||||
|
||||
### Section 1) Checks
|
||||
Make sure you've done the following checks before submitting a feature request.
|
||||
- type: 'checkboxes'
|
||||
attributes:
|
||||
label: 'I confirm that I have ...'
|
||||
description: 'Click the checkboxes to "check" them. Make sure you actually did what they mention.'
|
||||
options:
|
||||
- label: '...tried the latest [Development Build](https://ci.citizensnpcs.co/job/Citizens2/) to make sure my feature doesn''t exist already.'
|
||||
required: true
|
||||
- label: '...checked the Wiki for any possible information about my feature.'
|
||||
required: true
|
||||
- label: '...checked other existing issues for my feature request.'
|
||||
required: true
|
||||
- type: 'markdown'
|
||||
attributes:
|
||||
value: |-
|
||||
----
|
||||
|
||||
### Section 2) Description and Code
|
||||
Give a detailed description of why it is useful and possibly some code example.
|
||||
- type: 'textarea'
|
||||
attributes:
|
||||
label: 'Description'
|
||||
description: |-
|
||||
Describe your new feature as detailed as possible and try to answer the following question with it:
|
||||
|
||||
1. Why should it be added?
|
||||
2. What are the benefits for others?
|
||||
3. Are there existing alternatives you considered?
|
||||
placeholder: 'Citizens should have ... to allow ...'
|
||||
validations:
|
||||
required: true
|
||||
- type: 'textarea'
|
||||
attributes:
|
||||
label: 'Code Example'
|
||||
description: |-
|
||||
Feel free to share possible code-examples on how this feature may be implemented. This is completely optional.
|
||||
The text field will automatically render the provided text as Java Code.
|
||||
|
||||
Leave blank if you don't have an example.
|
||||
placeholder: |-
|
||||
public void newAwesomeFeature() {
|
||||
System.out.println("Awesome!");
|
||||
}
|
||||
render: java
|
||||
@ -1,12 +0,0 @@
|
||||
<!--
|
||||
** DO NOT IGNORE **
|
||||
Issue posts that fail to follow the instructions here will be automatically closed!
|
||||
Please include:
|
||||
- A detailed description of your issue or feature request
|
||||
- Link to server log & Citizens config (using e.g. pastebin.com)
|
||||
- **Spigot and Citizens versions!** Use in-game commands "/version" and "/version citizens" and screenshot or copy/paste the EXACT output of BOTH commands!
|
||||
- FOR LAG RELATED ISSUES: please include server specs, number of NPCs, saves.yml and the output of a profiler like Spark (NOT just Spigot timings, though that can be included as well)
|
||||
-->
|
||||
|
||||
The output of command `/version` on my server is: **(PLEASE FILL IN)**
|
||||
The output of command `/version citizens` on my server is: **(PLEASE FILL IN)**
|
||||
Loading…
Reference in New Issue
Block a user