-
-
Notifications
You must be signed in to change notification settings - Fork 35
Updates GitHub issue- and PR templates #47
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
Merged
JeroenWeener
merged 2 commits into
Baseflow:main
from
JeroenWeener:enhancement/update-github-templates
Jun 20, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
23 changes: 0 additions & 23 deletions
.github/ISSUE_TEMPLATE/a-regression.md
Oops, something went wrong.
98 changes: 98 additions & 0 deletions
.github/ISSUE_TEMPLATE/a-regression.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| name: Submit a regression | ||
| description: You encountered unexpected behavior that worked in a previous version of the plugin. | ||
| title: "[Regression]: " | ||
| labels: ["needs-triage"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to submit a regression! | ||
| To effectively tackle it, we require as much information as possible. This will allow us to quickly get to the root of the regression. | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Is there an existing issue for this? | ||
| description: Please search to see if an issue already exists for this regression. | ||
| options: | ||
| - label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues). | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Old behavior | ||
| description: | | ||
| Please provide a brief and precise description of the functionality that the Google API availability plugin had before the regression occurred. | ||
| Understanding the previous capabilities will assist us in pinpointing the changes and addressing the regression effectively. | ||
|
|
||
| Consider attaching something showing the old behavior: | ||
| * code samples | ||
| * images | ||
| * videos | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Current behavior | ||
| description: | | ||
| Please provide a brief and precise description of the functionality that the Google API availability plugin has now. | ||
| Understanding the current capabilities will assist us in pinpointing the changes and addressing the regression effectively. | ||
|
|
||
| Please attach something showing the current behavior: | ||
| * code samples | ||
| * images | ||
| * videos | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: Please provide specific steps to reproduce the situation in which the regression manifests. | ||
| placeholder: | | ||
| 1. ... | ||
| 2. ... | ||
| 3. ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Code sample | ||
| description: | | ||
| Please create a minimal reproducible sample that shows the regression | ||
| and attach it below between the lines with the backticks. | ||
|
|
||
| IMPORTANT: Please do not upload screenshots of text. Instead, use code blocks | ||
| or the above mentioned ways to upload your code sample. | ||
| value: | | ||
| <details><summary>Code sample</summary> | ||
|
|
||
| ```dart | ||
| [Paste your code here] | ||
| ``` | ||
|
|
||
| </details> | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Screenshots or video | ||
| description: | | ||
| Please consider uploading any relevant screenshots or videos showcasing the regression, if available. These visual aids can greatly assist us in understanding and addressing the issue more effectively. | ||
| value: | | ||
| <details> | ||
| <summary>Screenshots or video demonstration</summary> | ||
|
|
||
| [Upload media here] | ||
|
|
||
| </details> | ||
| - type: input | ||
| attributes: | ||
| label: Current version | ||
| description: Please specify which version of the plugin are you currently using. | ||
| placeholder: ex. 1.2.3 | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| attributes: | ||
| label: Last version without regression | ||
| description: Please specify the version of the plugin in which the regression was not yet present. | ||
| placeholder: ex. 1.2.2 | ||
| validations: | ||
| required: true |
21 changes: 0 additions & 21 deletions
.github/ISSUE_TEMPLATE/b-bug-report.md
Oops, something went wrong.
95 changes: 95 additions & 0 deletions
.github/ISSUE_TEMPLATE/b-bug-report.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| name: Report a bug | ||
| description: You encountered a bug in the Google API availability plugin resulting in application crashes, compilation errors or invalid/unexpected results. | ||
| title: "[Bug]: " | ||
| labels: ["needs-triage"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to submit an issue! | ||
| To effectively tackle it, we require as much information as possible. This might seem a lot of information but | ||
| will allow us to quickly help you and resolve the issue you are facing. | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Please check the following before submitting a new issue. | ||
| options: | ||
| - label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues). | ||
| - label: I have carefully [read the documentation](https://github.com/Baseflow/flutter-google-api-availability/blob/main/google_api_availability/README.md) and verified I have added the required platform specific configuration. | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: Please provide specific steps to reproduce the issue. | ||
| placeholder: | | ||
| 1. ... | ||
| 2. ... | ||
| 3. ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Expected results | ||
| description: Please provide a description of the expected behavior. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Actual results | ||
| description: Please provide a description of the current behavior. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Code sample | ||
| description: | | ||
| Please create a minimal reproducible sample that shows the problem | ||
| and attach it below between the lines with the backticks. | ||
|
|
||
| IMPORTANT: Please do not upload screenshots of text. Instead, use code blocks | ||
| or the above mentioned ways to upload your code sample. | ||
| value: | | ||
| <details><summary>Code sample</summary> | ||
|
|
||
| ```dart | ||
| [Paste your code here] | ||
| ``` | ||
|
|
||
| </details> | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Screenshots or video | ||
| description: | | ||
| Please consider uploading any relevant screenshots or videos showcasing the regression, if available. | ||
| These visual aids can greatly assist us in understanding and addressing the issue more effectively. | ||
| value: | | ||
| <details> | ||
| <summary>Screenshots or video demonstration</summary> | ||
|
|
||
| [Upload media here] | ||
|
|
||
| </details> | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: Version | ||
| description: Please specify in which version of the plugin the bug occurs. | ||
| placeholder: ex. 1.2.3 | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Flutter Doctor output | ||
| description: | | ||
| Please provide the full output of running `flutter doctor -v`. | ||
| value: | | ||
| <details><summary>Doctor output</summary> | ||
|
|
||
| ```console | ||
| [Paste your output here] | ||
| ``` | ||
|
|
||
| </details> | ||
| validations: | ||
| required: true |
19 changes: 0 additions & 19 deletions
.github/ISSUE_TEMPLATE/c-feature-request.md
Oops, something went wrong.
59 changes: 59 additions & 0 deletions
.github/ISSUE_TEMPLATE/c-feature-request.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| name: Submit a feature request | ||
| description: We value your input! If you have any ideas or suggestions for new features, we encourage you to share them here. | ||
| title: "[Feature request]: " | ||
| labels: ["needs-triage"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for submitting a feature request! To help us better understand your request, kindly take a moment to provide the following information. Your input is greatly appreciated. | ||
|
|
||
| - Description of the feature request. | ||
| - Use case or problem it solves. | ||
| - Any specific requirements or considerations. | ||
| - Any additional information or context. | ||
|
|
||
| Thank you for your cooperation! | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Is there already an issue requesting this feature? | ||
| description: Please search to see if an issue already exists for this feature request. | ||
| options: | ||
| - label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues). | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Use case | ||
| description: | | ||
| We appreciate your feature request! | ||
| In order to better understand your needs, please provide details regarding the problem you're encountering that prompted your desire for a new feature. | ||
|
|
||
| Is your feature request driven by a specific problem? | ||
| Kindly provide a clear and concise description of the issue at hand. | ||
|
|
||
| Additionally, please share any alternative solutions you have considered. | ||
| Have you explored existing packages on pub.dev that might already address this problem? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Proposal | ||
| description: | | ||
| Please provide a brief and precise description of the functionality that you are proposing. | ||
|
|
||
| Please attach something showing what you are imagining: | ||
| * code samples | ||
| * images | ||
| * videos | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Specific requirements or considerations | ||
| description: | | ||
| Please provide any specific requirements or considerations that you have for this feature request. | ||
| - type: textarea | ||
| attributes: | ||
| label: Additional information or context | ||
| description: | | ||
| Please provide any additional information or context that you have for this feature request. Also links pointing to existing (native) APIs or articles are extremely helpful. |
17 changes: 0 additions & 17 deletions
.github/ISSUE_TEMPLATE/d-enhancement-proposal.md
Oops, something went wrong.
40 changes: 40 additions & 0 deletions
.github/ISSUE_TEMPLATE/d-enhancement-proposal.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: Submit an enhancement proposal | ||
| description: You have a proposal for code cleanup, a refactor, or other improvements. | ||
| title: "[Enhancement proposal]: " | ||
| labels: ["needs-triage"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to submit an enhancement proposal! | ||
| Please take the time to fill out the information below so that we can better evaluate the need for the enhancement. | ||
| - type: checkboxes | ||
| attributes: | ||
| label: Please check the following before submitting a new issue. | ||
| options: | ||
| - label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues). | ||
| required: true | ||
| - label: I have carefully [read the documentation](https://github.com/baseflow/flutter-google-api-availability/blob/main/google_api_availability/README.md) and verified I have added the required platform specific configuration. | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Proposal | ||
| description: | | ||
| Please provide a clear and concise description of your proposed enhancement. | ||
|
|
||
| Please attach something showcasing your idea: | ||
| * code samples | ||
| * images | ||
| * videos | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| attributes: | ||
| label: Pitch | ||
| description: | | ||
| How will this refactor enhance the lives of contributors? | ||
| We would greatly appreciate it if you could provide us with as many details as possible. | ||
| Specifically, please describe the specific benefits, improvements, or advantages that contributors can expect to experience as a result of this refactor. | ||
| Your comprehensive input will help us better understand the impact and value of implementing this change. | ||
| validations: | ||
| required: true |
11 changes: 0 additions & 11 deletions
.github/ISSUE_TEMPLATE/e-question.md
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.