From c9c713f17bd1754820f99bf7da5ab87384799b4f Mon Sep 17 00:00:00 2001 From: GJS Date: Mon, 31 Mar 2025 13:34:24 +0200 Subject: [PATCH] Updated: Modify feature request template for improved clarity - Updated the description for the "related-issues" section to include specific links for searching issues and pull requests. - Enhanced clarity in the placeholder text for the "related-issues" section to provide better examples. - Adjusted the formatting for consistent use of markdown and description clarity. modified: .github/ISSUE_TEMPLATE/feature_request.yml --- .github/ISSUE_TEMPLATE/feature_request.yml | 70 ++++++++++++---------- 1 file changed, 40 insertions(+), 30 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 0674c6c96..e42c2f428 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,10 +1,11 @@ --- name: 🚀 Feature Request -description: "Submit a proposal for a new feature" -# title: "[Feature] " +description: | + Submit a proposal for a new feature +# title: "[Feature]" labels: ["feature-request", "P3-low"] body: - - type: "markdown" + - type: markdown attributes: value: | ## **❗ Important: Temporary Delay in Feature Requests and Pull Request Reviews** @@ -25,25 +26,26 @@ body: - **Why**: To help maintainers focus on high-priority tasks, we kindly request that unnecessary or repeated pings be minimized. This will help ensure quicker responses for matters that truly need attention. - **What This Means**: Non-urgent pings may be ignored or addressed later. Please assess the urgency of your request before pinging a maintainer. + - type: textarea id: related-issues validations: required: true attributes: - label: "📑 I have found these related issues/pull requests" - description: - "Search related issues by clicking - [HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain - what the difference between them or explain that you are unable to find - any related issues" - placeholder: - "Related to #1 by also touching the ... system. They should not be - merged because ..." + label: 📑 I have found these related issues/pull requests + description: | + Please search for related **[ISSUES](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc)** + and **[PULL REQUESTS](https://github.com/louislam/uptime-kuma/pulls?q=is%3Apr+sort%3Acreated-desc+)**. + Explain the differences between them or clarify if you were unable to find any related issues/pull requests. + placeholder: | + Example: This relates to issue #1, which also affects the ... system. It should not be merged because ... + - type: dropdown id: feature-area attributes: - label: "🏷️ Feature Request Type" - description: "What kind of feature request is this?" + label: 🏷️ Feature Request Type + description: | + What kind of feature request is this? multiple: true options: - API / automation options @@ -60,39 +62,47 @@ body: - Other validations: required: true + - type: textarea id: feature-description validations: required: true attributes: - label: "🔖 Feature description" - description: - "A clear and concise description of what the feature request is." - placeholder: "You should add ..." + label: 🔖 Feature description + description: | + A clear and concise description of what the feature request is. + placeholder: | + You should add ... + - type: textarea id: solution validations: required: true attributes: - label: "✔️ Solution" - description: "A clear and concise description of what you want to happen." - placeholder: "In my use-case, ..." + label: ✔️ Solution + description: | + A clear and concise description of what you want to happen. + placeholder: | + In my use-case, ... + - type: textarea id: alternatives validations: required: false attributes: - label: "❓ Alternatives" - description: - "A clear and concise description of any alternative solutions or - features you've considered." - placeholder: "I have considered ..." + label: ❓ Alternatives + description: | + A clear and concise description of any alternative solutions or features you've considered. + placeholder: | + I have considered ... + - type: textarea id: additional-context validations: required: false attributes: - label: "📝 Additional Context" - description: - "Add any other context or screenshots about the feature request here." - placeholder: "..." + label: 📝 Additional Context + description: | + Add any other context or screenshots about the feature request here. + placeholder: | + ...