From 5c7789c16814b127d0db47b4992fc3461f49516e Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sat, 19 Apr 2025 13:01:03 +0200 Subject: [PATCH] .github/ISSUE_TEMPLATE: merge rfc.yaml and feature.yaml into suggestion.yaml Signed-off-by: Patrik Oldsberg --- .github/ISSUE_TEMPLATE/feature.yaml | 54 ------------- .github/ISSUE_TEMPLATE/rfc.yaml | 51 ------------ .github/ISSUE_TEMPLATE/suggestion.yaml | 108 +++++++++++++++++++++++++ 3 files changed, 108 insertions(+), 105 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/feature.yaml delete mode 100644 .github/ISSUE_TEMPLATE/rfc.yaml create mode 100644 .github/ISSUE_TEMPLATE/suggestion.yaml diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml deleted file mode 100644 index b2d5a6be81..0000000000 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ /dev/null @@ -1,54 +0,0 @@ -name: πŸš€ Feature -description: 'Submit a proposal for a new feature' -title: 'πŸš€ Feature: ' -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 diff --git a/.github/ISSUE_TEMPLATE/rfc.yaml b/.github/ISSUE_TEMPLATE/rfc.yaml deleted file mode 100644 index 8e73992dc8..0000000000 --- a/.github/ISSUE_TEMPLATE/rfc.yaml +++ /dev/null @@ -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 diff --git a/.github/ISSUE_TEMPLATE/suggestion.yaml b/.github/ISSUE_TEMPLATE/suggestion.yaml new file mode 100644 index 0000000000..6bd5ea5549 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/suggestion.yaml @@ -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