From f127c9325cda76e47967d0c918dc3e10ed9bd27e Mon Sep 17 00:00:00 2001 From: Manuel <30572287+manuel-rw@users.noreply.github.com> Date: Tue, 24 Dec 2024 14:05:59 +0100 Subject: [PATCH] config: update issue templates (#1751) --- .github/ISSUE_TEMPLATE/bug_report.yml | 75 +++++++++++++++++----- .github/ISSUE_TEMPLATE/feature_request.yml | 14 +--- .github/ISSUE_TEMPLATE/integration.yml | 40 ++++++++++++ .github/ISSUE_TEMPLATE/widget.yml | 30 +++++++++ 4 files changed, 130 insertions(+), 29 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/integration.yml create mode 100644 .github/ISSUE_TEMPLATE/widget.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 54199a8d4..e03d0202b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,37 +1,78 @@ name: 🐞 Bug Report -description: Create a bug report to help us improve +description: Report that something is broken, not working as intended or causes side-effects title: "bug: " -labels: ["🐞❔ unconfirmed bug"] +labels: ["needs triage"] body: - - type: textarea - attributes: - label: Provide environment information - description: | - Run this command in your project root and paste the results in a code block: - ```bash - npx envinfo --system --binaries - ``` - validations: - required: true - type: textarea attributes: label: Describe the bug description: A clear and concise description of the bug, as well as what you expected to happen when encountering it. validations: required: true - - type: input + - type: textarea attributes: - label: Link to reproduction - description: Please provide a link to a reproduction of the bug. Issues without a reproduction repo may be ignored. + label: Steps to reproduce + description: Describe how to reproduce your bug. Steps, code snippets, reproduction repos etc. validations: required: true - type: textarea attributes: - label: To reproduce - description: Describe how to reproduce your bug. Steps, code snippets, reproduction repos etc. + label: Impact + description: How big is the impact of this bug? Does it make Homarr unusable? Is there any workaround that you're aware of? validations: required: true - type: textarea attributes: label: Additional information description: Add any other information related to the bug here, screenshots if applicable. + - type: dropdown + id: version + attributes: + label: Version + description: What version of Homarr are you running? + options: + - 1.0.0-beta + - Other (describe in "additional information") + default: 0 + validations: + required: true + - type: dropdown + id: installationMethod + attributes: + label: Installation method + description: How do you run Homarr? Post docker-compose, configs or screenshots if applicable. + options: + - Docker Run + - Docker Compose + - Portainer + - Helm + - QNAP + - Saltbox + - EasyPanel + - Unraid Apps + - TrueNAS Apps + - Synology + - HomeAssistant Addon + - From Source + - Other (describe in "additional information") + default: 0 + validations: + required: true + - type: dropdown + id: browser + attributes: + label: Browser + description: If relevant, what browser do you use? + options: + - Firefox + - Edge (Chromium) + - Edge (Proprietary) + - Chrome + - Safari + - Vivaldi + - Brave + - Samsung Internet + - Other (describe in "additional information") + default: 0 + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index c2be403e0..a2f69cc3a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -2,26 +2,16 @@ # See here: https://github.com/vercel/next.js/blob/canary/.github/ISSUE_TEMPLATE/3.feature_request.yml name: 🛠 Feature Request -description: Create a feature request for the core packages +description: Request a new feature that you would like to have implemented title: "feat: " -labels: ["✨ enhancement"] +labels: ["needs triage"] body: - - type: markdown - attributes: - value: | - Thank you for taking the time to file a feature request. Please fill out this form as completely as possible. - type: textarea attributes: label: Describe the feature you'd like to request description: Please describe the feature as clear and concise as possible. Remember to add context as to why you believe this feature is needed. validations: required: true - - type: textarea - attributes: - label: Describe the solution you'd like to see - description: Please describe the solution you would like to see. Adding example usage is a good way to provide context. - validations: - required: true - type: textarea attributes: label: Additional information diff --git a/.github/ISSUE_TEMPLATE/integration.yml b/.github/ISSUE_TEMPLATE/integration.yml new file mode 100644 index 000000000..3aeb492e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/integration.yml @@ -0,0 +1,40 @@ +name: 🛠 Integration request +description: Request support for a new integration (eg. Sonarr, Radarr) +title: "feat: " +labels: ["needs triage"] +body: + - type: input + attributes: + label: Project Website + description: Post the link to the website of the application. Paste the official link. + placeholder: ex. https://sonarr.tv/ + validations: + required: true + - type: textarea + attributes: + label: Describe what data should be consumed by Homarr + description: Please describe what data Homarr should fetch from the integration. Specify in what interval data should be fetched and whether the user can also perform write operations (eg. deleting a movie or adding a user). + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: Add any other information related to the integration. + - type: dropdown + attributes: + label: Public API available? + description: Is there a public API available, that we can consume in Homarr? + options: + - Yes, available on a website + - Yes, available in the application itself + - No + validations: + required: true + - type: dropdown + attributes: + label: Are you willing to contribute this yourself? + options: + - Yes + - No + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/widget.yml b/.github/ISSUE_TEMPLATE/widget.yml new file mode 100644 index 000000000..9ede8d0ba --- /dev/null +++ b/.github/ISSUE_TEMPLATE/widget.yml @@ -0,0 +1,30 @@ +name: 🛠 Widget request +description: Request a new widget (eg. Clock, Calendar, ...) +title: "feat: " +labels: ["needs triage"] +body: + - type: input + attributes: + label: Compatible integrations + description: Post a list of the integrations that should be compatible with this widget. Divide using comma. Leave empty if no integration is needed. + placeholder: ex. Sonarr, Radarr, Lidarr, Readarr, Nextcloud + validations: + required: false + - type: textarea + attributes: + label: Describe what data should be displayed + description: Please describe what data Homarr should display. Describe how elements should be intractable and what actions the user can perform. + validations: + required: true + - type: textarea + attributes: + label: Additional information + description: Add any other information related to the widget. + - type: dropdown + attributes: + label: Are you willing to contribute this yourself? + options: + - Yes + - No + validations: + required: true