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

Merge pull request #14275 from Rutam21/BKS-14264

Browse Source 
Issue-14264: Removed Issue Forms and Added Issue Templates
This commit is contained in:
Ben Lambert
2022-10-29 18:37:11 -04:00
committed by GitHub
parent f777433ab3 e287bd017f
commit a8cf285b8f
10 changed files with 294 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/ISSUE_TEMPLATE/bug.yaml
+84
View File
@@ -0,0 +1,84 @@
name: '🐛 Bug Report'
description: 'Submit a bug report to help us improve'
title: '🐛 Bug Report: '
labels:
- bug
body:
- type: markdown
attributes:
value: We value your time and effort to submit this bug report. 🙏
- type: textarea
id: description
validations:
required: true
attributes:
label: '📜 Description'
description: 'A clear and concise description of what the bug is.'
placeholder: 'It bugs out when ...'
- type: textarea
id: expected-behavior
validations:
required: true
attributes:
label: '👍 Expected behavior'
description: 'What did you think should happen?'
placeholder: 'It should ...'
- type: textarea
id: actual-behavior
validations:
required: true
attributes:
label: '👎 Actual Behavior with Screenshots'
description: 'What did actually happen? Add screenshots, if applicable.'
placeholder: 'It actually ...'
- type: textarea
id: steps-to-reproduce
validations:
required: true
attributes:
label: '👟 Reproduction steps'
description: 'How do you trigger this bug? Please walk us through it step by step.'
placeholder:
"Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code or configuration to reproduce, if relevant.\n
1. Go to '...'\n
2. Click on '....'\n
3. Scroll down to '....'"
- type: textarea
id: context
validations:
required: false
attributes:
label: '📃 Provide the context for the Bug.'
description: 'How has this issue affected you? What are you trying to accomplish?'
placeholder: 'Providing context (e.g. links to configuration settings, stack trace or log data) helps us come up with a solution that is most useful in the real world.'
- type: textarea
id: environment
validations:
required: false
attributes:
label: '🖥️ Your Environment'
description: 'Provide Browser Information
Provide Output of `yarn backstage-cli info`'
placeholder: 'Include as many relevant details about the environment you experienced the bug in.'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: '👀 Have you spent some time to check if this bug 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
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/bug_template.md
-44
View File
@@ -1,44 +0,0 @@
---
name: 'Bug Report'
about: 'Create Bug Report'
labels: bug
---
<!---
Please use this template when reporting bugs. Thank you!
-->
## Expected Behavior
<!--- Tell us what should happen -->
## Actual Behavior
<!--- Tell us what happens instead -->
## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code or configuration to reproduce, if relevant -->
1. Step 1
2. Step 2
3. ...
## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context (e.g. links to configuration settings, -->
<!--- stack trace or log data) helps us come up with a solution that is most useful in the real world -->
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
- Browser Information: <!--- For example Google Chrome 97.0.4692.99 -->
- Output of `yarn backstage-cli info`: <!--- Paste into the code block below -->
```text
```
.github/ISSUE_TEMPLATE/feature.yaml
+54
View File
@@ -0,0 +1,54 @@
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 [Contributing Guidelines](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/feature_template.md
-22
View File
@@ -1,22 +0,0 @@
---
name: 'Feature Request'
about: 'Suggest new features and changes'
labels: enhancement
---
<!--- Provide a general summary of the feature request in the Title above -->
## Feature Suggestion
<!--- If you're looking for help, please see https://backstage.io/ --->
<!--- Tell us how we could improve your experience -->
## Possible Implementation
<!--- Not obligatory, but ideas as to the implementation of the addition or change -->
## Context
<!--- What are you trying to accomplish? -->
<!--- Providing context (e.g. links to configuration settings, stack trace or log data) -->
<!--- helps us come up with a solution that is most useful in the real world -->
.github/ISSUE_TEMPLATE/plugin.yaml
+52
View File
@@ -0,0 +1,52 @@
name: 🔌 Plugin
description: 'Submit a proposal for a new Plugin'
title: '🔌 Plugin: '
labels: [plugin]
body:
- type: markdown
attributes:
value: |
We value your time and efforts to submit this Plugin request form. 🙏
- type: textarea
id: plugin-summary
validations:
required: true
attributes:
label: '🔖 Summary'
description: 'Provide a general summary of the plugin and how it should work'
placeholder: 'You should add ...'
- type: textarea
id: website
attributes:
label: '🌐 Project website (if applicable)'
description: 'Add a link to the open source project or product this plugin will integrate with, if existing'
placeholder: 'Website Link is ...'
- type: textarea
id: context
attributes:
label: '✌️ Context'
description: 'A clear and concise description about the Plugin.'
placeholder: 'Providing additional context'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: '👀 Have you spent some time to check if this plugin 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 [Contributing Guidelines](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/plugin_template.md
-21
View File
@@ -1,21 +0,0 @@
---
name: 'Plugin suggestion'
about: 'Suggest a new Backstage plugin'
title: '[Plugin] THE PLUGIN NAME'
labels: plugin
---
<!--- Thanks for suggesting a new plugin! -->
<!--- If you plan to work on this plugin, please Assign yourself or your team member(s) -->
## Summary
<!--- Provide a general summary of the plugin and how it should work -->
## Project website (if applicable)
<!--- Add a link to the open source project or product this plugin will integrate with, if existing -->
## Context
<!--- Providing additional context -->
.github/ISSUE_TEMPLATE/rfc.yaml
+51
View File
@@ -0,0 +1,51 @@
name: 💬 RFC
description: 'Request For Comments (RFC) from the community'
title: '💬 RFC: '
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/rfc_template.md
-26
View File
@@ -1,26 +0,0 @@
---
name: 'RFC'
about: 'Request For Comments (RFC) from the community'
labels: rfc
title: '[RFC] <name>'
---
**Status:** Open for comments
<!--- Open for comments |Closed for comments (RFC no longer maintained) --->
## Need
<!--- Why are we proposing this change? Why is this the problem we’re trying to address and what benefits/impact do we expect to get from this --->
## Proposal
<!--- The proposed approach. Describe the proposal in as much detail as needed for reviewers to give concrete feedback. Take special care in this section to describe any implications on data privacy or security. --->
## Alternatives
<!--- What alternatives to the proposed solution were considered? What criteria/data was used to discard these --->
## Risks
<!--- What other things happening could conflict or compete (for example for resources) with the proposal? What risk are there and how do we plan to handle them --->
.github/ISSUE_TEMPLATE/ux-component_template.md
-23
View File
@@ -1,23 +0,0 @@
---
name: 'UX Component'
about: 'For designers to request UX components to be added to the Backstage Storybook'
labels: design
---
## 🗒 General
<!--- Write a nice note to the community requesting the creation of a new component! -->
<!--- Include an image of your component. Bonus points for a GIF! -->
## 💻 Usage
<!--- Tell us what the point of this component/pattern is! How does it help? How should it work? Any rules? -->
## 📐 Specs
<!--- Include images that detail the redlines for your component.-->
<!--- Once we get our Figma workspace set up, we'll be posting the Figma files rather than doing specs by hand.-->
## 🔮 Future
<!-- Any upcoming, exciting functionality for this component in the future? List that out here. -->
.github/ISSUE_TEMPLATE/ux_component.yaml
+53
View File
@@ -0,0 +1,53 @@
name: 🦄 UX Component
description: 'For designers to request UX components to be added to the Backstage Storybook'
title: '🦄 UX Component: '
labels: [design]
body:
- type: markdown
attributes:
value: |
We value your time and efforts to submit this RFC form. 🙏
- type: textarea
id: ux-general
validations:
required: true
attributes:
label: '🔖 General'
description: 'Write a nice note to the community requesting the creation of a new component.'
placeholder: 'Include an image of your component. Bonus points for a GIF!'
- type: textarea
id: usage
validations:
required: true
attributes:
label: '💻 Usage'
description: "Tell us what's the point of this component/pattern is."
placeholder: 'How does it help? How should it work? Any rules?'
- type: textarea
id: specs
validations:
required: true
attributes:
label: '📐 Specs'
description: 'Include images that detail the redlines for your component.'
placeholder: "Once we get our Figma workspace set up, we'll be posting the Figma files rather than doing specs by hand."
- type: textarea
id: future
attributes:
label: '🔮 Future'
description: 'List out any upcoming, exciting functionality for this component.'
placeholder: 'The component will have ...'
- type: checkboxes
id: no-duplicate-issues
attributes:
label: '👀 Have you spent some time to check if this UX Component 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