From 1dd074bbb4717369a0e17c154a0c7e937262399e Mon Sep 17 00:00:00 2001 From: Deluan Date: Mon, 6 Mar 2023 17:15:36 -0500 Subject: [PATCH] Add new issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 37 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 103 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ----- 4 files changed, 108 insertions(+), 61 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d15776f2..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Bug Report -about: Use this template for submitting a bug report. -title: "" -labels: bug -assignees: "" ---- - - -### Description - -A clear and concise description of what the bug is. - -### Expected Behaviour - -What you would have expected to happen instead. - -### Steps to reproduce - -1. Open the '...' -2. Click on '...' -3. Scroll down to '...' -4. See error - -### Platform information - - - Navidrome version: - - Browser and version: - - Operating System: - -### Additional information - -Any other information that may be relevant or give context to the problem. - - - Screenshots (if applicable)? - - Logs? - - Client used? diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..9fb6bd61 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,103 @@ +name: Bug Report +description: Before opening a new issue, please search to see if an issue already exists for the bug you encountered. +title: "[Bug]: " +labels: ["bug", "triage"] +assignees: + - deluan +body: + - type: markdown + attributes: + value: | + ### Thanks for taking the time to fill out this bug report! + - type: checkboxes + id: requirements + attributes: + label: But first, have you done your homework? + options: + - label: I have searched the existing [open AND closed issues](https://github.com/navidrome/navidrome/issues?q=is%3Aissue) to see if an issue already exists for the bug I've encountered + required: true + - label: I'm using the latest version (your issue may have been fixed already) + required: false + - type: input + id: version + attributes: + label: Version + description: What version of Navidrome are you running? (please try upgrading first, as your issue may have been fixed already). + validations: + required: true + - type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. In this scenario... + 2. With this config... + 3. Click (or Execute) '...' + 4. See error... + validations: + required: false + - type: textarea + id: env + attributes: + label: Environment + description: | + examples: + - **OS**: Ubuntu 20.04 + - **Browser**: Chrome 110.0.5481.177 on Windows 11 + - **Client**: DSub 5.5.1 + value: | + - OS: + - Browser: + - Client: + render: markdown + - type: dropdown + id: distribution + attributes: + label: How Navidrome is installed? + multiple: false + options: + - Docker + - Binary (from downloads page) + - Package + - Built from sources + validations: + required: true + - type: textarea + id: config + attributes: + label: Configuration + description: Please copy and paste your `navidrome.toml` (and/or `docker-compose.yml`) configuration. This will be automatically formatted into code, so no need for backticks. + render: toml + - type: textarea + id: logs + attributes: + label: Relevant log output + description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. ([Where I can find the logs?](https://www.navidrome.org/docs/faq/#where-are-the-logs)) + render: shell + - type: textarea + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach screenshots by clicking this area to highlight it and then dragging files in. + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/navidrome/navidrome/blob/master/CODE_OF_CONDUCT.md). + options: + - label: I agree to follow Navidrome's Code of Conduct + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..aa2c1c9b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Support and Feature requests + url: https://github.com/navidrome/navidrome/discussions + about: This is the place to ask questions and to share ideas. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 5c052ecf..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature Request -about: Use this template to request for a feature. -title: "" -labels: enhancement -assignees: "" ---- - - -### Is your feature request related to a problem? Please describe. - -A clear and concise description of what the problem is. For e.g. I'm always frustrated when '...' - -### Describe the solution you'd like - -A clear and concise description of what you would like to happen. - -### Describe alternative solutions that would also satisfy this problem - -A clear and concise description of any alternative solutions or features you've considered. - -### Additional context - -Add any other context or screenshots about the feature request here.