Skip to content

Commit

Permalink
docs: update bug report formatting (#212)
Browse files Browse the repository at this point in the history
  • Loading branch information
smallTrogdor authored Dec 4, 2024
1 parent cbe4be8 commit 40289db
Showing 1 changed file with 34 additions and 44 deletions.
78 changes: 34 additions & 44 deletions .github/ISSUE_TEMPLATE/bug-report-mobile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,92 +8,82 @@ body:
- type: markdown
attributes:
value: |
# Thanks for taking the time to fill out this bug report!
## Preflight Checklist
**Thanks for taking the time to fill out this bug report!**
### Preflight Checklist
- type: checkboxes
id: preflight-checklist
attributes:
label: Preflight Checklist
options:
- label: I have read the [Contributing Guidelines](https://github.com/SchweizerischeBundesbahnen/design_system_flutter/blob/main/Contributing.md) for this project.
- label: I have read the [Contributing Guidelines](https://github.com/SchweizerischeBundesbahnen/design_system_flutter/blob/main/CONTRIBUTING.md) for this project.
required: true
- label: I have searched the [issue tracker](https://github.com/...) for an issue that matches the one I want to file, without success.
- label: I have searched the [issue tracker](https://github.com/SchweizerischeBundesbahnen/design_system_flutter/issues) for an issue that matches the one I want to file, without success.
required: true
- type: markdown
attributes:
value: |
## General Information
### General Information
- type: dropdown
id: bug-type
attributes:
label: Bug type
options:
- 'Functionality'
- 'Accessibility'
- 'Performance'
- 'Security vulnerability'
- 'Other'
- "Functionality"
- "Accessibility"
- "Performance"
- "Security vulnerability"
- "Other"
validations:
required: true
- type: dropdown
id: repository
attributes:
label: It affects the following repositories
options:
- 'Flutter'
- 'Swift'
- 'Both'
- 'Other'
validations:
required: true
- type: dropdown
id: platform
attributes:
label: It affects the following platform (only for flutter)
options:
- 'Web'
- 'Native'
- 'Both'
- type: input
id: version
attributes:
label: Which release are you using
description: e.g. 0.7.2
label: Which release are you using?
description: e.g. 2.0.0
validations:
required: false
- type: markdown
attributes:
value: |
## Environment
### Environment
- type: input
id: flutter-version
attributes:
label: Flutter SDK version
description: e.g. '3.24.5'
validations:
required: false
- type: input
id: additional-settings
attributes:
label: Additional settings
description: e.g. save data active
label: Additional settings
placeholder: e.g. dark theme active
validations:
required: false
- type: markdown
attributes:
value: |
## Detailed description
### Detailed description
- type: textarea
id: what-was-expected
attributes:
label: Expected
description: What did you expect to happen?
placeholder: Describe what should happen if the bug was fixed.
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: |
Describe in detail the issue you are having.
What did you expect to happen? What happened instead? What would you like to see changed?
Is the issue related to a specific component?
description: What did actually happen?
placeholder: In contrast to the expected behavior, describe what currently happens when the bug is present.
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to reproduce the issue
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
value: |
1. Step one
2. Step two
Expand All @@ -105,4 +95,4 @@ body:
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
render: shell

0 comments on commit 40289db

Please sign in to comment.