-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from google/templates
adding templates for PRs and reports
- Loading branch information
Showing
4 changed files
with
122 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,66 @@ | ||
--- | ||
name: "⚠️ Bug Report" | ||
about: Report a bug with existing Flutter MediaPipe features. | ||
title: "\U0001F41B [PLUGIN_NAME_HERE] Your issue title here" | ||
labels: 'Needs Attention, type: bug' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Bug report | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
### Steps to reproduce | ||
|
||
Steps to reproduce the behavior: | ||
|
||
1. Go to '...' | ||
2. '...' | ||
4. See error or incorrect behavior | ||
|
||
### Expected behavior | ||
|
||
A clear and concise description of what you expected to happen. | ||
|
||
### Sample project | ||
|
||
Providing a [minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) project which demonstrates the bug in isolation from your main App _greatly_ enhances the chance of a timely fix. | ||
Please link to the public repository URL. | ||
|
||
--- | ||
|
||
## Additional context | ||
|
||
Add any other context about the problem here. | ||
|
||
--- | ||
|
||
### Flutter doctor | ||
|
||
Run `flutter doctor` and paste the output below: | ||
|
||
<details><summary>Click To Expand</summary> | ||
|
||
``` | ||
PASTE OUTPUT INSIDE HERE | ||
``` | ||
|
||
</details> | ||
|
||
--- | ||
|
||
### Flutter dependencies | ||
|
||
Run `flutter pub deps -- --style=compact` and paste the output below: | ||
|
||
<details><summary>Click To Expand</summary> | ||
|
||
``` | ||
PASTE OUTPUT INSIDE HERE | ||
``` | ||
|
||
</details> | ||
|
||
--- |
This file contains 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,10 @@ | ||
--- | ||
name: "\U0001F4DA Documentation Feedback" | ||
about: Report an issue with the relevant MediaPipe documentation or suggest an improvement. | ||
title: "[\U0001F4DA] Your documentation feedback title (CHANGE ME)" | ||
labels: 'good first issue, type: documentation' | ||
assignees: '' | ||
|
||
--- | ||
|
||
Please describe your documentation issue or suggested improvement in detail here and provide links to any pre-existing/relevant documentation and screenshots if necessary: |
This file contains 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,11 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Feature Request | ||
url: https://github.com/google/flutter-mediapipe/discussions/new?category=feature-request | ||
about: Share ideas for new features. | ||
- name: Ask a Question | ||
url: https://github.com/google/flutter-mediapipe/discussions/new?category=q-a | ||
about: Ask the community for help. | ||
- name: Show and tell | ||
url: https://github.com/google/flutter-mediapipe/discussions/new?category=show-and-tell | ||
about: Share what you've built with FlutterFire. |
This file contains 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,35 @@ | ||
## Description | ||
|
||
*Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, and what motivated the change.* | ||
|
||
## Related Issues | ||
|
||
*Replace this paragraph with a list of issues related to this PR from the [issue database](https://github.com/google/flutter-mediapipe/issues). Indicate, which of these issues are resolved or fixed by this PR. Note that you'll have to prefix the issue numbers with flutter/flutter#.* | ||
|
||
## Checklist | ||
|
||
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). | ||
This will ensure a smooth and quick review process. Updating the `pubspec.yaml` and changelogs is not required. | ||
|
||
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. | ||
- [ ] My PR includes unit or integration tests for *all* changed/updated/fixed behaviors (See [Contributor Guide]). | ||
- [ ] All existing and new tests are passing. | ||
- [ ] I updated/added relevant documentation (doc comments with `///`). | ||
- [ ] The analyzer (`melos run analyze`) does not report any problems on my PR. | ||
- [ ] I read and followed the [Flutter Style Guide]. | ||
- [ ] I signed the [CLA]. | ||
- [ ] I am willing to follow-up on review comments in a timely manner. | ||
|
||
## Breaking Change | ||
|
||
Does your PR require plugin users to manually update their apps to accommodate your change? | ||
|
||
- [ ] Yes, this is a breaking change. | ||
- [ ] No, this is *not* a breaking change. | ||
|
||
<!-- Links --> | ||
[issue database]: https://github.com/google/flutter-mediapipe/issues | ||
[Contributor Guide]: https://github.com/google/flutter-mediapipe/blob/master/CONTRIBUTING.md | ||
[Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo | ||
[pub versioning philosophy]: https://dart.dev/tools/pub/versioning | ||
[CLA]: https://cla.developers.google.com/ |