Skip to content

Commit 3046f3e

Browse files
authored
Merge pull request #1 from google/templates
adding templates for PRs and reports
2 parents ae30bd6 + 1ed16d5 commit 3046f3e

File tree

4 files changed

+122
-0
lines changed

4 files changed

+122
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
name: "⚠️ Bug Report"
3+
about: Report a bug with existing Flutter MediaPipe features.
4+
title: "\U0001F41B [PLUGIN_NAME_HERE] Your issue title here"
5+
labels: 'Needs Attention, type: bug'
6+
assignees: ''
7+
8+
---
9+
10+
## Bug report
11+
12+
**Describe the bug**
13+
A clear and concise description of what the bug is.
14+
15+
### Steps to reproduce
16+
17+
Steps to reproduce the behavior:
18+
19+
1. Go to '...'
20+
2. '...'
21+
4. See error or incorrect behavior
22+
23+
### Expected behavior
24+
25+
A clear and concise description of what you expected to happen.
26+
27+
### Sample project
28+
29+
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.
30+
Please link to the public repository URL.
31+
32+
---
33+
34+
## Additional context
35+
36+
Add any other context about the problem here.
37+
38+
---
39+
40+
### Flutter doctor
41+
42+
Run `flutter doctor` and paste the output below:
43+
44+
<details><summary>Click To Expand</summary>
45+
46+
```
47+
PASTE OUTPUT INSIDE HERE
48+
```
49+
50+
</details>
51+
52+
---
53+
54+
### Flutter dependencies
55+
56+
Run `flutter pub deps -- --style=compact` and paste the output below:
57+
58+
<details><summary>Click To Expand</summary>
59+
60+
```
61+
PASTE OUTPUT INSIDE HERE
62+
```
63+
64+
</details>
65+
66+
---
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: "\U0001F4DA Documentation Feedback"
3+
about: Report an issue with the relevant MediaPipe documentation or suggest an improvement.
4+
title: "[\U0001F4DA] Your documentation feedback title (CHANGE ME)"
5+
labels: 'good first issue, type: documentation'
6+
assignees: ''
7+
8+
---
9+
10+
Please describe your documentation issue or suggested improvement in detail here and provide links to any pre-existing/relevant documentation and screenshots if necessary:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Feature Request
4+
url: https://github.com/google/flutter-mediapipe/discussions/new?category=feature-request
5+
about: Share ideas for new features.
6+
- name: Ask a Question
7+
url: https://github.com/google/flutter-mediapipe/discussions/new?category=q-a
8+
about: Ask the community for help.
9+
- name: Show and tell
10+
url: https://github.com/google/flutter-mediapipe/discussions/new?category=show-and-tell
11+
about: Share what you've built with FlutterFire.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Description
2+
3+
*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.*
4+
5+
## Related Issues
6+
7+
*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#.*
8+
9+
## Checklist
10+
11+
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`).
12+
This will ensure a smooth and quick review process. Updating the `pubspec.yaml` and changelogs is not required.
13+
14+
- [ ] I read the [Contributor Guide] and followed the process outlined there for submitting PRs.
15+
- [ ] My PR includes unit or integration tests for *all* changed/updated/fixed behaviors (See [Contributor Guide]).
16+
- [ ] All existing and new tests are passing.
17+
- [ ] I updated/added relevant documentation (doc comments with `///`).
18+
- [ ] The analyzer (`melos run analyze`) does not report any problems on my PR.
19+
- [ ] I read and followed the [Flutter Style Guide].
20+
- [ ] I signed the [CLA].
21+
- [ ] I am willing to follow-up on review comments in a timely manner.
22+
23+
## Breaking Change
24+
25+
Does your PR require plugin users to manually update their apps to accommodate your change?
26+
27+
- [ ] Yes, this is a breaking change.
28+
- [ ] No, this is *not* a breaking change.
29+
30+
<!-- Links -->
31+
[issue database]: https://github.com/google/flutter-mediapipe/issues
32+
[Contributor Guide]: https://github.com/google/flutter-mediapipe/blob/master/CONTRIBUTING.md
33+
[Flutter Style Guide]: https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
34+
[pub versioning philosophy]: https://dart.dev/tools/pub/versioning
35+
[CLA]: https://cla.developers.google.com/

0 commit comments

Comments
 (0)