From 3fb54b83a717e1ab197861f4d62b8f72f0d9da0d Mon Sep 17 00:00:00 2001 From: Turiiya <34311583+ttytm@users.noreply.github.com> Date: Wed, 5 Jun 2024 01:09:05 +0200 Subject: [PATCH] ci: add issue templates to facilitate the faster resolution of reports --- .github/ISSUE_TEMPLATE/bug-report.yml | 84 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 ++ .github/ISSUE_TEMPLATE/feature-request.yml | 69 ++++++++++++++++++ 3 files changed, 159 insertions(+) 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 diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..69c4c7e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,84 @@ +name: 🐛 Bug Report +description: File a bug report. +labels: [bug] + +body: + - type: markdown + attributes: + value: Thanks for taking the time to fill out this bug report! + + - type: textarea + id: description + attributes: + label: Describe the Bug + description: What happened? A clear and concise description of the bug. + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happened? + validations: + required: true + + - type: textarea + id: reproduction + attributes: + label: Reproduction Steps + description: | + Providing a self-contained, concise code example that can be used to reproduce the issue. + Can help to solve the problem as fast as possible. + + For more complex issues provide a repo with the smallest sample that reproduces the bug. + + Avoid including business logic or unrelated code, it makes diagnosis more difficult. + The code sample should be an SSCCE. See http://sscce.org/ for details. + In short, please provide a code sample that we can copy/paste, run and reproduce. + validations: + required: false + + - type: textarea + id: logs + attributes: + label: Error Logs + render: 'shell' + description: | + Please include full errors, uncaught exceptions, stack traces. + Trigger the issue with WebUI's debug build to add relevant logs. + validations: + required: false + + - type: textarea + id: suggestion + attributes: + label: Possible Solution + description: If you can suggest fix, include a prototype/workaround/sketch/reference. + validations: + required: false + + - type: input + id: version + attributes: + label: Version + description: Please provide the current WebUI version you are using. + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment details (OS name and version, etc.) + render: shell + description: | + To fill in this section, you can use on Unix-like systems: + ```sh + uname -somr + ``` + On Windows you can use: + ```sh + cmd /c wmic cpu get systemname,caption + ``` + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a350389 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,6 @@ +blank_issues_enabled: true + +contact_links: + - name: 💬 WebUI Community Support + url: https://github.com/webui-dev/webui/discussions + about: Please can ask and answer questions about WebUI here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..0c4d999 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,69 @@ +name: 🚀 Feature Request +description: Suggest an idea for this project. +labels: [enhancement] + +body: + - type: textarea + id: description + attributes: + label: Describe the Feature + description: A clear and concise description of the feature you are proposing. + validations: + required: true + + - type: textarea + id: use-case + attributes: + label: Use Case + description: Why do you need this feature? + validations: + required: true + + - type: textarea + id: suggestion + attributes: + label: Proposed Solution + description: If you can suggest how the addition or change can be implemented, include a prototype/workaround/sketch/reference implementation. + validations: + required: false + + - type: textarea + id: other + attributes: + label: Other Information + description: Any alternative solutions or features you considered, a more detailed explanation, stack traces, related issues, links for context, etc. + validations: + required: false + + - type: checkboxes + id: implementation + attributes: + label: Implementation + options: + - label: I may be able to implement the feature. + - label: It might incur a breaking change. + + - type: input + id: version + attributes: + label: Version + description: Please provide the current WebUI version you are using. + validations: + required: true + + - type: textarea + id: environment + attributes: + label: Environment details (OS name and version, etc.) + render: shell + description: | + To fill in this section, you can use on Unix-like systems: + ```sh + uname -somr + ``` + On Windows you can use: + ```sh + cmd /c wmic cpu get systemname,caption + ``` + validations: + required: true