paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 50 Packages Projects Releases Wiki Activity

.github/ISSUE_TEMPLATE: merge rfc.yaml and feature.yaml into suggestion.yaml

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-04-19 13:01:03 +02:00
parent ef797aa0bb
commit 5c7789c168
3 changed files with 108 additions and 105 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/feature.yaml
-54
View File
@@ -1,54 +0,0 @@
name: 🚀 Feature
description: 'Submit a proposal for a new feature'
title: '🚀 Feature: <title>'
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
We value your time and efforts to submit this Feature request form. 🙏
- type: textarea
id: feature-description
validations:
required: true
attributes:
label: '🔖 Feature description'
description: 'A clear and concise description of what the feature is.'
placeholder: 'You should add ...'
- type: textarea
id: context
validations:
required: true
attributes:
label: '🎤 Context'
description: 'Please explain why this feature should be implemented and how it would be used. Add examples, if applicable.'
placeholder: 'In my use-case, ...'
- type: textarea
id: implementation
attributes:
label: '✌️ Possible Implementation'
description: 'A clear and concise description of what you want to happen.'
placeholder: 'Not obligatory, but ideas as to the implementation of the addition or change'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: '👀 Have you spent some time to check if this feature request has been raised before?'
options:
- label: "I checked and didn't find similar issue"
required: true
- type: checkboxes
id: read-code-of-conduct
attributes:
label: '🏢 Have you read the Code of Conduct?'
options:
- label: 'I have read the [Code of Conduct](https://github.com/backstage/backstage/blob/master/CODE_OF_CONDUCT.md)'
required: true
- type: dropdown
id: willing-to-submit-pr
attributes:
label: Are you willing to submit PR?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- Yes I am willing to submit a PR!
- No, but I'm happy to collaborate on a PR with someone else
- No, I don't have time to work on this right now
.github/ISSUE_TEMPLATE/rfc.yaml
-51
View File
@@ -1,51 +0,0 @@
name: 💬 RFC
description: 'Request For Comments (RFC) from the community'
title: '💬 RFC: <title>'
labels: [rfc]
body:
- type: markdown
attributes:
value: |
We value your time and efforts to submit this RFC form. 🙏
- type: textarea
id: rfc-need
validations:
required: true
attributes:
label: '🔖 Need'
description: 'Let us know why are you proposing this change'
placeholder: 'The problem we’re trying to address and the benefits/impact we expect to get from this are ...'
- type: textarea
id: proposal
validations:
required: true
attributes:
label: '🎉 Proposal'
description: 'Describe the proposal in as much detail as needed for reviewers to give concrete feedback.'
placeholder: 'Take special care in this section to describe any implications on data privacy or security.'
- type: textarea
id: alternatives
attributes:
label: '〽️ Alternatives'
description: 'What alternatives to the proposed solution were considered?'
placeholder: 'What criteria/data was used to discard these?'
- type: textarea
id: risk
attributes:
label: '❌ Risks'
description: 'What other things happening could conflict or compete (for example for resources) with the proposal?'
placeholder: 'What risk are there and how do we plan to handle them?'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: '👀 Have you spent some time to check if this RFC has been raised before?'
options:
- label: "I checked and didn't find similar issue"
required: true
- type: checkboxes
id: read-code-of-conduct
attributes:
label: '🏢 Have you read the Code of Conduct?'
options:
- label: 'I have read the [Code of Conduct](https://github.com/backstage/backstage/blob/master/CODE_OF_CONDUCT.md)'
required: true
.github/ISSUE_TEMPLATE/suggestion.yaml
+108
View File
@@ -0,0 +1,108 @@
name: '💡 Change Suggestion'
description: 'Suggest an idea for a new feature or change to Backstage'
labels:
- type:suggestion
- status:needs-triage
body:
- type: markdown
attributes:
value: |
This template helps you propose new features, enhancements, or other ideas for Backstage. You can keep your proposal lightweight, but please provide enough detail for reviewers to understand and respond effectively.
For complex additions, consider creating a [Backstage Enhancement Proposal](https://github.com/backstage/backstage/blob/master/beps/README.md) (BEP) instead, as this process streamlines discussions and iteration. Don't worry - you can always convert this issue to a BEP later.
- type: checkboxes
id: issue-labels
attributes:
label: '📜 Issue Labels'
options:
- label: 'Please familiarize yourself with the issue labels used in this project: [LABELS.md](https://github.com/backstage/backstage/blob/master/LABELS.md)'
required: true
- type: textarea
id: search-terms
attributes:
label: '🔎 Search Terms'
render: plain
description: |
What search terms did you use when trying to find an existing feature proposal?
placeholder: |
List of keywords you searched for before creating this issue. Write them down here so that others can find this bug more easily and help provide feedback.
e.g. "catalog github rate limited", "http root service configurer", "scaffolder template include", "entity card title"
validations:
required: true
- type: dropdown
id: project-area
attributes:
label: '🗃️ Project Area'
description: What area of the project would this feature be related to? This will help find an owner for the issue faster.
options:
- Unknown
- Auditor
- Catalog
- CLI Tooling
- Core Framework
- Design System
- Documentation
- Events System
- Home
- Kubernetes Plugin
- Microsite
- Notifications
- OpenAPI Tooling
- Permission Framework
- Software Templates
- Search
- TechDocs
validations:
required: true
- type: textarea
id: need
validations:
required: true
attributes:
label: '🔖 Need'
description: What is the rationale for this change, and who will benefit from it?
placeholder: |
Explain why this change is important and who will benefit from it. Provide context for the change, such as highlighting relevant past work in this area.
- type: textarea
id: proposal
validations:
required: true
attributes:
label: '📝 Proposal'
description: Describe the change that you are suggesting.
placeholder: |
Provide sufficient detail for reviewers to give concrete feedback.
Including a proposed implementation is optional, but if you do, consider adding design details such as TypeScript examples, database schema, or sequence diagrams.
If the change requires particular care when being rolled out, it can be helpful to for example include a plan for a phased release.
- type: textarea
id: alternatives
attributes:
label: '🔄 Alternatives'
description: Did you consider any other approaches?
placeholder: |
Did you consider any other approaches, and if so, why did you rule them out?
These do not need to be as detailed as the main proposal, but should include enough information to understand the idea and why it wasn't suitable.
- type: checkboxes
id: read-code-of-conduct
attributes:
label: 'Have you read the Code of Conduct?'
options:
- label: 'I have read the [Code of Conduct](https://github.com/backstage/backstage/blob/master/CODE_OF_CONDUCT.md)'
required: true
- type: dropdown
id: willing-to-submit-pr
attributes:
label: Are you willing to submit PR?
description: This is absolutely not required, but we are happy to guide you in the contribution process.
options:
- Undecided
- Yes, and I have enough information to get started
- Yes, but I would like some more guidance
- No, but I'm happy to collaborate on a PR with someone else
- No, I don't have time to work on this right now
validations:
required: true