From a8f9ece32f96bc2ebdcd21ebd9a94f555ef93b8e Mon Sep 17 00:00:00 2001 From: 92 <169070113+I21b@users.noreply.github.com> Date: Fri, 17 Oct 2025 21:51:51 +0900 Subject: [PATCH] docs: Update issue templates (#2644) --- .../{bug_report.yaml => bug_report.yml} | 24 ++++---- .github/ISSUE_TEMPLATE/config.yml | 18 ++++++ .github/ISSUE_TEMPLATE/feature_request.yaml | 29 --------- .github/ISSUE_TEMPLATE/feature_request.yml | 59 +++++++++++++++++++ 4 files changed, 90 insertions(+), 40 deletions(-) rename .github/ISSUE_TEMPLATE/{bug_report.yaml => bug_report.yml} (81%) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yml similarity index 81% rename from .github/ISSUE_TEMPLATE/bug_report.yaml rename to .github/ISSUE_TEMPLATE/bug_report.yml index 9281d8c6..c0043f92 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -4,19 +4,21 @@ title: "bug: " labels: [bug] body: - type: checkboxes - id: duplication + id: confirm attributes: - label: ⠀ + label: Read [this](https://github.com/localsend/localsend/issues/528) before anything options: - - label: This issue is not duplicated with any other open or closed issues - required: true + - label: I have read it. + - label: Issues not fitting are closed. - type: checkboxes - id: latest + id: duplication attributes: - label: ⠀ + label: "Make sure about:" options: - - label: I am using the latest version from the release + - label: This issue is not duplicated with any other open or closed issues. + required: true + - label: I am using the latest version from the release. required: true - type: textarea @@ -47,12 +49,12 @@ body: label: Reproduction description: Steps to reproduce the bug placeholder: | - 1. Turn on "What" in "What settings" + 1. Turn on "..." in "... settings" 2. Restart the app 3. Crash / - 1. Transfer a "What" file is What size takes What long - 2. Observe What + 1. Transfer a "..." file is ... size takes ... long + 2. Observe ... 3. Crash validations: required: true @@ -88,6 +90,6 @@ body: label: Additional context description: Add any other context about the problem here placeholder: | - Crash report or other helpful information + Crash report or any helpful information. validations: required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..faa34dbc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,18 @@ +blank_issues_enabled: false +contact_links: + - name: Security issues + url: https://github.com/localsend/localsend/blob/main/CONTRIBUTING.md#security-issues + about: Help us address security issues as quickly and effectively as possible + + - name: Get latest LocalSend + url: https://localsend.org/download + about: Your issue may be version related, so try updating first + + - name: GitHub Discussions + url: https://github.com/localsend/localsend/discussions + about: If you think your issue isn't that serious, you can discuss it here + + - name: Contributing guide + url: https://github.com/localsend/localsend/blob/main/CONTRIBUTING.md + about: Check our contributing guide if you’re interested or have time + diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml deleted file mode 100644 index f96c77d3..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ /dev/null @@ -1,29 +0,0 @@ -name: Feature request -description: Suggest an idea for this project -title: Feature request -labels: ["feature :sparkles:"] -body: - - type: textarea - id: feature_request_description - attributes: - label: Is your feature request related to a problem? Please describe. - description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - validations: - required: true - - type: textarea - id: feature_request_solution_description - attributes: - label: Describe the solution you'd like - description: A clear and concise description of what you want to happen - validations: - required: true - - type: textarea - id: feature_request_alternatives - attributes: - label: Describe alternatives you've considered - description: A clear and concise description of any alternative solutions or features you've considered - - type: textarea - id: feature_request_additional_context - attributes: - label: Additional context - description: Add any other context or screenshots about the feature request here diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..d12eaa91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,59 @@ +name: Feature request +description: Suggest an idea for this project +title: "fr: " +labels: ["enhancement"] +body: + - type: checkboxes + id: confirm + attributes: + label: Read [this](https://github.com/localsend/localsend/issues/528) before anything + options: + - label: I have read it. + - label: Issues not fitting are closed. + + - type: checkboxes + id: duplication + attributes: + label: "Make sure about:" + options: + - label: This issue is not duplicated with any other open or closed issues. + required: true + - label: This issue is a feature request, not a bug report. + required: true + + - type: textarea + id: reason + attributes: + label: Reason of the change + description: Why the things need to be changed? Inconvenient or logical wrong? + placeholder: | + Because if I want to ..., I'll need to ... + It's not very ... to do so ... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Description of the change + description: What should we change or add, to make it better? + placeholder: | + If there's a choice like ..., it will be more ... + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: The alternatives you've considered + description: If we are unable to do that above, any other solution? + placeholder: | + Add a ... also helps ... + + - type: textarea + id: additional + attributes: + label: Additional context + description: Add any other context or screenshots about the request here + placeholder: | + Related app, website, system, or a design. Anything helpful can be here.