docs: Add issue template #2812
docs: Add issue template #2812
Conversation
|
Initially looks good, it should be updated to reflect what is in here though: And octocat should not be the default assignee. 😂 |
.github/ISSUE_TEMPLATE/config.yml
Outdated
| attributes: | ||
| label: What happened? | ||
| description: Tell us, what happened? | ||
| placeholder: Tell us what you see! |
There was a problem hiding this comment.
I don't think there is need for a placeholder here
.github/ISSUE_TEMPLATE/config.yml
Outdated
| attributes: | ||
| label: What do you expect? | ||
| description: Also tell us, what behavior did you expect? | ||
| placeholder: Tell us what you want! |
There was a problem hiding this comment.
I don't think there is need for a placeholder here
.github/ISSUE_TEMPLATE/config.yml
Outdated
| description: Also tell us, what behavior did you expect? | ||
| placeholder: Tell us what you want! | ||
| validations: | ||
| required: false |
.github/ISSUE_TEMPLATE/config.yml
Outdated
| # Steps to reproduce | ||
| <!-- This one is very important, please be very precise in how we can reproduce this bug --> | ||
| <!-- If possible please report steps based on the example from this plugin! --> | ||
| <!-- 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. --> | ||
|
|
||
| # Flutter doctor output | ||
| <!-- Execute in a terminal and put output into code block below --> | ||
| ``` | ||
| Output of: flutter doctor -v | ||
| ``` | ||
|
|
||
| # 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 | ||
| <!-- Do you have any other useful information about this bug report? Please write it down here --> | ||
| <!-- Possible helpful information: references to other sites/repositories --> | ||
| <!-- Are you interested in working on a PR for this? --> |
There was a problem hiding this comment.
These questions should be part of the form
|
Hi @spydon I have made changes to the file. Could you please look into it :) |
.github/ISSUE_TEMPLATE/config.yml
Outdated
| # Flutter doctor output | ||
| Execute in a terminal and put output into the code block below | ||
| ``` | ||
| Output of: flutter doctor -v | ||
| ``` |
There was a problem hiding this comment.
| # 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 |
There was a problem hiding this comment.
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:
|
Made a few changes :) |
.github/ISSUE_TEMPLATE/config.yml
Outdated
| - name: Join us on Discord! | ||
| url: https://discord.gg/pxrBmy4 | ||
| about: Ask your questions in our community! | ||
| name: Bug Report |
There was a problem hiding this comment.
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).
There was a problem hiding this comment.
Hi @anleac does it look good now?
Description
This fixes #2805
I added a template to the issue form so you won't have to fill in the headers for an issue.
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues