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.

Sign up for GitHub

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

docs: Add issue template #2812

Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c77333d
Update config.yml
clairecharles Oct 10, 2023
6d0d3f5
Update config.yml
clairecharles Oct 11, 2023
776049e
Merge branch 'main' into main
clairecharles Oct 11, 2023
b8d24c8
Update config.yml
clairecharles Oct 11, 2023
5b4f2cf
Update config.yml
clairecharles Oct 11, 2023
8c5075f
Update config.yml
clairecharles Oct 14, 2023
fad5bd1
Create bug_report.yml
clairecharles Oct 16, 2023
a301e44
Update config.yml
clairecharles Oct 16, 2023
ffb267f
Merge branch 'main' into main
spydon Oct 17, 2023
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
101 changes: 93 additions & 8 deletions .github/ISSUE_TEMPLATE/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,93 @@
blank_issues_enabled: true
contact_links:
- name: I have some questions about Flame.
url: https://stackoverflow.com/tags/flame
about: Ask your questions on StackOverflow! The community is always willing to help out.
- name: Join us on Discord!
url: https://discord.gg/pxrBmy4
about: Ask your questions in our community!
name: Bug Report
Copy link

@anleac anleac Oct 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: I'm not sure if this is the changeset we want; the change of the markdown looks solid 🙇 But I don't believe we should be modifying the config.yml but instead be creating a new file, bug_report.yml for example, in this same folder with the contents you've added (each new template/form should be it's own unique file).

More info here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @anleac does it look good now?

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should also be required


- 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


# Flutter doctor output
Execute in a terminal and put output into the code block below
```
Output of: flutter doctor -v
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Flutter doctor output
Execute in a terminal and put output into the code block below
```
Output of: flutter doctor -v
```
- type: textarea
id: logs
attributes:
label: flutter doctor
description: Execute `flutter doctor` in a terminal and put output into the code block below
render: shell

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And similarly on all other markdown that is left underneath, so everything that starts with a # should have its own section that starts with type:


# More environment information

Create a list of more environment information, like:
* Flame version: 1.0.0
* Platform affected: android, ios, web
* 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