diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml new file mode 100644 index 0000000000..782b5fdfa0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/bug_template.md b/.github/ISSUE_TEMPLATE/bug_template.md deleted file mode 100644 index 04f8fd68d0..0000000000 --- a/.github/ISSUE_TEMPLATE/bug_template.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: 'Bug Report' -about: 'Create Bug Report' -labels: bug ---- - - - -## Expected Behavior - - - -## Actual Behavior - - - -## Steps to Reproduce - - - - -1. Step 1 -2. Step 2 -3. ... - -## Context - - - - - -## Your Environment - - - -- Browser Information: - -- Output of `yarn backstage-cli info`: - -```text - -``` diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml new file mode 100644 index 0000000000..9cac5055f1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/feature_template.md b/.github/ISSUE_TEMPLATE/feature_template.md deleted file mode 100644 index d70622bf52..0000000000 --- a/.github/ISSUE_TEMPLATE/feature_template.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -name: 'Feature Request' -about: 'Suggest new features and changes' -labels: enhancement ---- - - - -## Feature Suggestion - - - - -## Possible Implementation - - - -## Context - - - - diff --git a/.github/ISSUE_TEMPLATE/plugin.yaml b/.github/ISSUE_TEMPLATE/plugin.yaml new file mode 100644 index 0000000000..9f3a708b41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/plugin.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/plugin_template.md b/.github/ISSUE_TEMPLATE/plugin_template.md deleted file mode 100644 index 75f0828848..0000000000 --- a/.github/ISSUE_TEMPLATE/plugin_template.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -name: 'Plugin suggestion' -about: 'Suggest a new Backstage plugin' -title: '[Plugin] THE PLUGIN NAME' -labels: plugin ---- - - - - -## Summary - - - -## Project website (if applicable) - - - -## Context - - diff --git a/.github/ISSUE_TEMPLATE/rfc.yaml b/.github/ISSUE_TEMPLATE/rfc.yaml new file mode 100644 index 0000000000..775c64e674 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rfc.yaml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/rfc_template.md b/.github/ISSUE_TEMPLATE/rfc_template.md deleted file mode 100644 index c4990ee5d6..0000000000 --- a/.github/ISSUE_TEMPLATE/rfc_template.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: 'RFC' -about: 'Request For Comments (RFC) from the community' -labels: rfc -title: '[RFC] ' ---- - -**Status:** Open for comments - - - -## Need - - - -## Proposal - - - -## Alternatives - - - -## Risks - - diff --git a/.github/ISSUE_TEMPLATE/ux-component_template.md b/.github/ISSUE_TEMPLATE/ux-component_template.md deleted file mode 100644 index 95b8f47615..0000000000 --- a/.github/ISSUE_TEMPLATE/ux-component_template.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: 'UX Component' -about: 'For designers to request UX components to be added to the Backstage Storybook' -labels: design ---- - -## ๐Ÿ—’ General - - - - -## ๐Ÿ’ป Usage - - - -## ๐Ÿ“ Specs - - - - -## ๐Ÿ”ฎ Future - - diff --git a/.github/ISSUE_TEMPLATE/ux_component.yaml b/.github/ISSUE_TEMPLATE/ux_component.yaml new file mode 100644 index 0000000000..453f1e8278 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ux_component.yaml @@ -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