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
This commit is contained in:
GJS 2025-03-31 13:34:24 +02:00
parent dd4db1232e
commit c9c713f17b
No known key found for this signature in database
GPG key ID: BE32D9EAF927E85B

View file

@ -1,10 +1,11 @@
--- ---
name: 🚀 Feature Request name: 🚀 Feature Request
description: "Submit a proposal for a new feature" description: |
# title: "[Feature] " Submit a proposal for a new feature
# title: "[Feature]"
labels: ["feature-request", "P3-low"] labels: ["feature-request", "P3-low"]
body: body:
- type: "markdown" - type: markdown
attributes: attributes:
value: | value: |
## **❗ Important: Temporary Delay in Feature Requests and Pull Request Reviews** ## **❗ 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. - **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. - **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 - type: textarea
id: related-issues id: related-issues
validations: validations:
required: true required: true
attributes: attributes:
label: "📑 I have found these related issues/pull requests" label: 📑 I have found these related issues/pull requests
description: description: |
"Search related issues by clicking Please search for related **[ISSUES](https://github.com/louislam/uptime-kuma/issues?q=is%3Aissue%20sort%3Acreated-desc)**
[HERE](https://github.com/louislam/uptime-kuma/issues?q=) and explain and **[PULL REQUESTS](https://github.com/louislam/uptime-kuma/pulls?q=is%3Apr+sort%3Acreated-desc+)**.
what the difference between them or explain that you are unable to find Explain the differences between them or clarify if you were unable to find any related issues/pull requests.
any related issues" placeholder: |
placeholder: Example: This relates to issue #1, which also affects the ... system. It should not be merged because ...
"Related to #1 by also touching the ... system. They should not be
merged because ..."
- type: dropdown - type: dropdown
id: feature-area id: feature-area
attributes: attributes:
label: "🏷️ Feature Request Type" label: 🏷️ Feature Request Type
description: "What kind of feature request is this?" description: |
What kind of feature request is this?
multiple: true multiple: true
options: options:
- API / automation options - API / automation options
@ -60,39 +62,47 @@ body:
- Other - Other
validations: validations:
required: true required: true
- type: textarea - type: textarea
id: feature-description id: feature-description
validations: validations:
required: true required: true
attributes: attributes:
label: "🔖 Feature description" label: 🔖 Feature description
description: description: |
"A clear and concise description of what the feature request is." A clear and concise description of what the feature request is.
placeholder: "You should add ..." placeholder: |
You should add ...
- type: textarea - type: textarea
id: solution id: solution
validations: validations:
required: true required: true
attributes: attributes:
label: "✔️ Solution" label: ✔️ Solution
description: "A clear and concise description of what you want to happen." description: |
placeholder: "In my use-case, ..." A clear and concise description of what you want to happen.
placeholder: |
In my use-case, ...
- type: textarea - type: textarea
id: alternatives id: alternatives
validations: validations:
required: false required: false
attributes: attributes:
label: "❓ Alternatives" label: ❓ Alternatives
description: description: |
"A clear and concise description of any alternative solutions or A clear and concise description of any alternative solutions or features you've considered.
features you've considered." placeholder: |
placeholder: "I have considered ..." I have considered ...
- type: textarea - type: textarea
id: additional-context id: additional-context
validations: validations:
required: false required: false
attributes: attributes:
label: "📝 Additional Context" label: 📝 Additional Context
description: description: |
"Add any other context or screenshots about the feature request here." Add any other context or screenshots about the feature request here.
placeholder: "..." placeholder: |
...