.github/ISSUE_TEMPLATE: update bug template

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-04-17 12:15:53 +02:00
parent 8c79a739a1
commit ef797aa0bb
+121 -49
View File
@@ -1,76 +1,144 @@
name: '🐛 Bug Report'
description: 'Submit a bug report to help us improve'
title: '🐛 Bug Report: <title>'
name: '🪲 Bug Report'
description: 'Report a bug that you have encountered'
labels:
- bug
- type:bug
- status:needs-triage
body:
- type: markdown
attributes:
value: We value your time and effort to submit this bug report. 🙏
value: |
Please fill in each section completely, and [search in GitHub](https://github.com/backstage/backstage/search?type=Issues)
before reporting a new bug in order to avoid duplicates. Thank you!
- 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 bug report?
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: markdown
attributes:
value: '<br/>' # empty space
- type: markdown
attributes:
value: |
## Defining the bug
Defining the bug accurately will help ensure that it is identified and fixed correctly.
- type: dropdown
id: project-area
attributes:
label: '🗃️ Project Area'
description: What area of the project do you think this bug is 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: dropdown
id: integration
attributes:
label: '🔗 External Integration'
description: Is this issue related to an integration with any particular external system?
options:
- N/A
- AWS
- Azure
- Azure DevOps
- Bitbucket Cloud
- Bitbucket Server
- GCP
- Gerrit
- GitHub
- GitLab
- Gitea
- LDAP
validations:
required: true
- 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 ...'
label: '📝 Description & Context'
placeholder: |
Describe the observed behavior that you deem to be incorrect, as well as any additional context that might be useful in understanding the bug.
e.g. "When i navigate to the catalog index page it loads without a hitch. May be related to https://xkcd.com/1172"
- 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
label: '👍 Expected Behavior'
placeholder: |
Describe the behavior or result that you expected instead of the observed one.
e.g. "I expect the catalog index page to overheat my CPU"
- type: markdown
attributes:
label: '👎 Actual Behavior with Screenshots'
description: 'What did actually happen? Add screenshots, if applicable.'
placeholder: 'It actually ...'
value: '<br/>' # empty space
- type: markdown
attributes:
value: |
## Reproducing the bug
Being able to easily reproduce the bug will significantly increase the likelihood that it can be identified and fixed. Please provide a repository where the bug can be reproduced, unless this is a critical bug that needs immediate attention.
If you are unable to provide a reproduction repo, please explain the reproduction steps in as much detail as possible, and include the output of `yarn backstage-cli info` if relevant.
If inadequate or no reproduction steps are provided, the bug report is likely to be labelled as needing reproduction steps before it can be progressed further.
- type: input
id: reproduction-repo
attributes:
label: '📦 Reproduction Repo'
description: A link to a GitHub repository where the issue can be reproduced
placeholder: https://github.com/ghost/my-repro-repo
validations:
required: false
- type: textarea
id: steps-to-reproduce
validations:
required: true
attributes:
label: '👟 Reproduction steps'
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
placeholder: |
1. Go to '...'
2. Click on '....'
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?'
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
@@ -79,6 +147,10 @@ body:
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!
- 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