diff --git a/.github/ISSUE_TEMPLATE/a-regression.md b/.github/ISSUE_TEMPLATE/a-regression.md deleted file mode 100644 index 186832e..0000000 --- a/.github/ISSUE_TEMPLATE/a-regression.md +++ /dev/null @@ -1,23 +0,0 @@ ---- - -name: πŸ”™ Regression -about: Report unexpected behavior that worked previously ---- - -## πŸ”™ Regression - - - -### Old (and correct) behavior - -### Current behavior - -### Reproduction steps - -### Configuration - -**Version:** 1.x - -**Platform:** -- [ ] :iphone: iOS -- [ ] :robot: Android \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/a-regression.yml b/.github/ISSUE_TEMPLATE/a-regression.yml new file mode 100644 index 0000000..08e93a5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/a-regression.yml @@ -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: | +
Code sample + + ```dart + [Paste your code here] + ``` + +
+ 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: | +
+ Screenshots or video demonstration + + [Upload media here] + +
+ - 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 diff --git a/.github/ISSUE_TEMPLATE/b-bug-report.md b/.github/ISSUE_TEMPLATE/b-bug-report.md deleted file mode 100644 index dbc4ab0..0000000 --- a/.github/ISSUE_TEMPLATE/b-bug-report.md +++ /dev/null @@ -1,21 +0,0 @@ ---- - -name: πŸ› Bug Report -about: Create a report to help us fix bugs and make improvements ---- - -## πŸ› Bug Report - - - -### Expected behavior - -### Reproduction steps - -### Configuration - -**Version:** 1.x - -**Platform:** -- [ ] :iphone: iOS -- [ ] :robot: Android \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/b-bug-report.yml b/.github/ISSUE_TEMPLATE/b-bug-report.yml new file mode 100644 index 0000000..077a633 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/b-bug-report.yml @@ -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: | +
Code sample + + ```dart + [Paste your code here] + ``` + +
+ 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: | +
+ Screenshots or video demonstration + + [Upload media here] + +
+ - 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: | +
Doctor output + + ```console + [Paste your output here] + ``` + +
+ validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/c-feature-request.md b/.github/ISSUE_TEMPLATE/c-feature-request.md deleted file mode 100644 index a094b3c..0000000 --- a/.github/ISSUE_TEMPLATE/c-feature-request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- - -name: πŸš€ Feature Request -about: Want to see something new included in the Framework? Submit it! ---- - -## πŸš€ Feature Requests - - - -### Contextualize the feature - - -### Describe the feature - - -### Platforms affected (mark all that apply) -- [ ] :iphone: iOS -- [ ] :robot: Android \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/c-feature-request.yml b/.github/ISSUE_TEMPLATE/c-feature-request.yml new file mode 100644 index 0000000..f644dd3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/c-feature-request.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/d-enhancement-proposal.md b/.github/ISSUE_TEMPLATE/d-enhancement-proposal.md deleted file mode 100644 index ee273a2..0000000 --- a/.github/ISSUE_TEMPLATE/d-enhancement-proposal.md +++ /dev/null @@ -1,17 +0,0 @@ ---- - -name: πŸ— Enhancement Proposal -about: Proposals for code cleanup, refactor and improvements in general ---- - -## πŸ— Enhancement Proposal - - - -### Pitch - - - -### Platforms affected (mark all that apply) -- [ ] :iphone: iOS -- [ ] :robot: Android \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/d-enhancement-proposal.yml b/.github/ISSUE_TEMPLATE/d-enhancement-proposal.yml new file mode 100644 index 0000000..552eccc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/d-enhancement-proposal.yml @@ -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 diff --git a/.github/ISSUE_TEMPLATE/e-question.md b/.github/ISSUE_TEMPLATE/e-question.md deleted file mode 100644 index 49618ef..0000000 --- a/.github/ISSUE_TEMPLATE/e-question.md +++ /dev/null @@ -1,11 +0,0 @@ ---- - -name: πŸ’¬ Questions and Help -about: If you have questions, please use this for support ---- - -## πŸ’¬ Questions and Help - -For questions or help we recommend checking: - -- The [Flutter tag in Stack Overflow](https://stackoverflow.com/questions/tagged/flutter) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/e-question.yml b/.github/ISSUE_TEMPLATE/e-question.yml new file mode 100644 index 0000000..2fd96ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/e-question.yml @@ -0,0 +1,38 @@ +name: Ask for help +description: You have a question about the Google API availability plugin and are looking for help. +title: "[Question]: " +labels: ["needs-triage"] +body: + - type: markdown + attributes: + value: | + We are happy to help you out! + To help you effectively, we require some information. This will allow us to quickly understand your question. + - 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). + required: true + - type: textarea + attributes: + label: Your question + description: | + Please describe your question as detailed as possible. + + Please attach something to help us understand your question: + * code samples + * images + * videos + validations: + required: true + - type: input + id: version + attributes: + label: Version + description: Please specify which version of the plugin are you currently using. + placeholder: ex. 1.2.3 + validations: + required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7d4328a..5712fa0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,24 +1,20 @@ -### :sparkles: What kind of change does this PR introduce? (Bug fix, feature, docs update...) - - -### :arrow_heading_down: What is the current behavior? - - -### :new: What is the new behavior (if this is a feature change)? - - -### :boom: Does this PR introduce a breaking change? - - -### :bug: Recommendations for testing - - -### :memo: Links to relevant issues/docs - - -### :thinking: Checklist before submitting - -- [ ] All projects build -- [ ] Follows style guide lines ([code style guide](https://github.com/BaseflowIT/flutter-google-api-availability/blob/main/CONTRIBUTING.md)) -- [ ] Relevant documentation was updated -- [ ] Rebased onto current develop +*Replace this paragraph with a short description of what issue this pull request (PR) solves and provide a description of the change. Consider including before/after screenshots.* + +*List at least one fixed issue.* + +## Pre-launch Checklist + +- [ ] I made sure the project builds. +- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. +- [ ] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is does not need version changes. +- [ ] I updated `CHANGELOG.md` to add a description of the change. +- [ ] I updated/added relevant documentation (doc comments with `///`). +- [ ] I rebased onto `main`. +- [ ] I added new tests to check the change I am making, or this PR does not need tests. +- [ ] I made sure all existing and new tests are passing. +- [ ] I ran `dart format .` and committed any changes. +- [ ] I ran `flutter analyze` and fixed any errors. + + +[Contributor Guide]: https://github.com/Baseflow/flutter-google-api-availability/blob/master/CONTRIBUTING.md +[pub versioning philosophy]: https://dart.dev/tools/pub/versioning

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /