Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add issue template #2812

Merged
merged 9 commits into from
Oct 17, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Bug Report
description: You are creating a Game with Flame but you are noticing some strange behavior, that it throws an unexpected exception, or that it is not working according to the specifications.
title: " "
labels: ["bug"]
assignees: ""
body:
- type: markdown
attributes:
value: |
When reporting a bug, please read this complete template and fill in all the questions in order to get a better response!
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Tell us, what happened?
validations:
required: true

- type: textarea
id: expectation
attributes:
label: What do you expect?
description: Also tell us, what behavior did you expect?
validations:
required: true

# Steps to reproduce

- type: textarea
id: expectation
attributes:
label: How can we reproduce this?
description: This one is very important, please be very precise in how we can reproduce this bug
validations:
required: false

- type: textarea
id: expectation
attributes:
label: What steps should take to fix this?
description: If possible please report steps based on the example from this plugin!
validations:
required: false

- type: textarea
id: expectation
attributes:
label: Do have an example of what change you want?
description: If you can make a minimal reproducible example it is incredibly helpful, the simplest way is to share a link from https://zapp.run, you can start from https://zapp.run/edit/flame where all dependencies are already set up.
validations:
required: false

- type: textarea
id: logs
attributes:
label: Relevant log output
description: If you have any debug / error logging, please fill it here within the code block below
render: shell


- type: markdown
attributes:
label: Execute in a terminal and put output into the code block below
value: ```
Output of: flutter doctor -v
```

# More environment information

- type: markdown
attributes:
label: Create a list of more environment information, like:
value: Flame version: 1.0.0
value: Platform affected: android, ios, web
value: Platform version affected: android 9, ios 13

# More information

- type: textarea
id: expectation
attributes:
label: What do you expect?
description: Do you have any other useful information about this bug report? Please write it down here
validations:
required: false


- type: checkboxes
id: terms
attributes:
label: Are you interested in working on a PR for this?
options:
- label: I want to work on this
required: false

## Possible helpful information: references to other sites/repositories