From e7d3a95981b8bfecdeb676dd750df8f107d2a6f7 Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Mon, 8 Nov 2021 15:23:04 +0100 Subject: [PATCH] Improve issue template using Issue forms (#2684) --- .github/ISSUE_TEMPLATE/bug_report.yml | 89 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 ++++ .github/ISSUE_TEMPLATE/feature_request.yml | 58 ++++++++++++++ ISSUE_TEMPLATE | 12 --- 4 files changed, 161 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 ISSUE_TEMPLATE diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..281777154 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..6ebe104f6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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' diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..213898955 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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 diff --git a/ISSUE_TEMPLATE b/ISSUE_TEMPLATE deleted file mode 100644 index b182bf3b6..000000000 --- a/ISSUE_TEMPLATE +++ /dev/null @@ -1,12 +0,0 @@ - - -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)**