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

Add new feature request template #1928

Merged
merged 1 commit into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
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
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@ body:
- type: markdown
attributes:
value: >
### Thank you for using Maestro
### Thank you for using Maestro!


Before creating a new issue, please first search the
[existing issues database] and make sure it hasn't been reported
before.
Before creating a new issue, please first search the [existing issues]
and make sure it hasn't been reported before.


If you are sure that you have found a bug that hasn't been reported yet,
Expand All @@ -20,7 +19,7 @@ body:
---


[existing issues database]: https://github.com/mobile-dev-inc/maestro
[existing issues]: https://github.com/mobile-dev-inc/maestro
- type: checkboxes
attributes:
label: Is there an existing issue for this?
Expand Down
73 changes: 73 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
name: Suggest a feature
description: You want to share a new idea to improve Maestro.
body:
- type: markdown
attributes:
value: >
### Thank you for using Maestro!


We can't wait to hear your idea!


If you're looking for support, check out our docs or consider asking a
question on our Discussions or Stack Overflow:

- https://maestro.mobile.dev
- https://github.com/leancodepl/patrol/discussions
- https://stackoverflow.com/questions/tagged/flutter-patrol

First, please search the [existing issues] to see if an issue already
exists for the feature you need.


---


If you are sure that the feature you want to suggest hasn't been
requested before, or if our documentation doesn't have an answer to what
you're looking for, then fill out the template below. Please bear in
mind that duplicates and unsufficiently described feature requests will
be closed.

[existing issues]: https://github.com/leancodepl/patrol/issues
- type: textarea
attributes:
label: Use case
description: |
Please tell us more about the use case you have that led to you wanting
this new feature.

Is your feature request related to a problem? Please give a clear and
concise description of what the problem is. This will help avoid the
[XY problem].

Describe the alternative solutions you've considered and the tradeoffs
they come with. The more context you can provide, the better.

[XY problem]: https://en.wikipedia.org/wiki/XY_problem
validations:
required: true
- type: textarea
attributes:
label: Proposal
description: |
Briefly but precisely describe what the new feature should look like
from the user perspective.

Consider attaching something showing what you are imagining:
* code samples (maybe you already know )
* API design ideas (e.g. of new YAML commands)
validations:
required: true
- type: textarea
validations:
required: false
attributes:
label: Anything else?
description: >
Links? Other issues? StackOverflow threads? Anything that will give us
more context about this feature request will be helpful.

> [!TIP]
> You can attach images or other files by clicking this area to highlight it and then dragging files in.