Skip to content

Commit 11f4b6a

Browse files
authored
Updates GitHub issue- and PR templates (#47)
* Update PULL_REQUEST_TEMPLATE.md * Update issue templates
1 parent 7e84e4c commit 11f4b6a

11 files changed

+350
-115
lines changed

.github/ISSUE_TEMPLATE/a-regression.md

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
name: Submit a regression
2+
description: You encountered unexpected behavior that worked in a previous version of the plugin.
3+
title: "[Regression]: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to submit a regression!
10+
To effectively tackle it, we require as much information as possible. This will allow us to quickly get to the root of the regression.
11+
- type: checkboxes
12+
attributes:
13+
label: Is there an existing issue for this?
14+
description: Please search to see if an issue already exists for this regression.
15+
options:
16+
- label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues).
17+
required: true
18+
- type: textarea
19+
attributes:
20+
label: Old behavior
21+
description: |
22+
Please provide a brief and precise description of the functionality that the Google API availability plugin had before the regression occurred.
23+
Understanding the previous capabilities will assist us in pinpointing the changes and addressing the regression effectively.
24+
25+
Consider attaching something showing the old behavior:
26+
* code samples
27+
* images
28+
* videos
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Current behavior
34+
description: |
35+
Please provide a brief and precise description of the functionality that the Google API availability plugin has now.
36+
Understanding the current capabilities will assist us in pinpointing the changes and addressing the regression effectively.
37+
38+
Please attach something showing the current behavior:
39+
* code samples
40+
* images
41+
* videos
42+
validations:
43+
required: true
44+
- type: textarea
45+
attributes:
46+
label: Steps to reproduce
47+
description: Please provide specific steps to reproduce the situation in which the regression manifests.
48+
placeholder: |
49+
1. ...
50+
2. ...
51+
3. ...
52+
validations:
53+
required: true
54+
- type: textarea
55+
attributes:
56+
label: Code sample
57+
description: |
58+
Please create a minimal reproducible sample that shows the regression
59+
and attach it below between the lines with the backticks.
60+
61+
IMPORTANT: Please do not upload screenshots of text. Instead, use code blocks
62+
or the above mentioned ways to upload your code sample.
63+
value: |
64+
<details><summary>Code sample</summary>
65+
66+
```dart
67+
[Paste your code here]
68+
```
69+
70+
</details>
71+
validations:
72+
required: true
73+
- type: textarea
74+
attributes:
75+
label: Screenshots or video
76+
description: |
77+
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.
78+
value: |
79+
<details>
80+
<summary>Screenshots or video demonstration</summary>
81+
82+
[Upload media here]
83+
84+
</details>
85+
- type: input
86+
attributes:
87+
label: Current version
88+
description: Please specify which version of the plugin are you currently using.
89+
placeholder: ex. 1.2.3
90+
validations:
91+
required: true
92+
- type: input
93+
attributes:
94+
label: Last version without regression
95+
description: Please specify the version of the plugin in which the regression was not yet present.
96+
placeholder: ex. 1.2.2
97+
validations:
98+
required: true

.github/ISSUE_TEMPLATE/b-bug-report.md

Lines changed: 0 additions & 21 deletions
This file was deleted.
Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
name: Report a bug
2+
description: You encountered a bug in the Google API availability plugin resulting in application crashes, compilation errors or invalid/unexpected results.
3+
title: "[Bug]: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to submit an issue!
10+
To effectively tackle it, we require as much information as possible. This might seem a lot of information but
11+
will allow us to quickly help you and resolve the issue you are facing.
12+
- type: checkboxes
13+
attributes:
14+
label: Please check the following before submitting a new issue.
15+
options:
16+
- label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues).
17+
- 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.
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Steps to reproduce
22+
description: Please provide specific steps to reproduce the issue.
23+
placeholder: |
24+
1. ...
25+
2. ...
26+
3. ...
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Expected results
32+
description: Please provide a description of the expected behavior.
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Actual results
38+
description: Please provide a description of the current behavior.
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Code sample
44+
description: |
45+
Please create a minimal reproducible sample that shows the problem
46+
and attach it below between the lines with the backticks.
47+
48+
IMPORTANT: Please do not upload screenshots of text. Instead, use code blocks
49+
or the above mentioned ways to upload your code sample.
50+
value: |
51+
<details><summary>Code sample</summary>
52+
53+
```dart
54+
[Paste your code here]
55+
```
56+
57+
</details>
58+
validations:
59+
required: true
60+
- type: textarea
61+
attributes:
62+
label: Screenshots or video
63+
description: |
64+
Please consider uploading any relevant screenshots or videos showcasing the regression, if available.
65+
These visual aids can greatly assist us in understanding and addressing the issue more effectively.
66+
value: |
67+
<details>
68+
<summary>Screenshots or video demonstration</summary>
69+
70+
[Upload media here]
71+
72+
</details>
73+
- type: input
74+
id: version
75+
attributes:
76+
label: Version
77+
description: Please specify in which version of the plugin the bug occurs.
78+
placeholder: ex. 1.2.3
79+
validations:
80+
required: true
81+
- type: textarea
82+
attributes:
83+
label: Flutter Doctor output
84+
description: |
85+
Please provide the full output of running `flutter doctor -v`.
86+
value: |
87+
<details><summary>Doctor output</summary>
88+
89+
```console
90+
[Paste your output here]
91+
```
92+
93+
</details>
94+
validations:
95+
required: true

.github/ISSUE_TEMPLATE/c-feature-request.md

Lines changed: 0 additions & 19 deletions
This file was deleted.
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
name: Submit a feature request
2+
description: We value your input! If you have any ideas or suggestions for new features, we encourage you to share them here.
3+
title: "[Feature request]: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
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.
10+
11+
- Description of the feature request.
12+
- Use case or problem it solves.
13+
- Any specific requirements or considerations.
14+
- Any additional information or context.
15+
16+
Thank you for your cooperation!
17+
- type: checkboxes
18+
attributes:
19+
label: Is there already an issue requesting this feature?
20+
description: Please search to see if an issue already exists for this feature request.
21+
options:
22+
- label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues).
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Use case
27+
description: |
28+
We appreciate your feature request!
29+
In order to better understand your needs, please provide details regarding the problem you're encountering that prompted your desire for a new feature.
30+
31+
Is your feature request driven by a specific problem?
32+
Kindly provide a clear and concise description of the issue at hand.
33+
34+
Additionally, please share any alternative solutions you have considered.
35+
Have you explored existing packages on pub.dev that might already address this problem?
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Proposal
41+
description: |
42+
Please provide a brief and precise description of the functionality that you are proposing.
43+
44+
Please attach something showing what you are imagining:
45+
* code samples
46+
* images
47+
* videos
48+
validations:
49+
required: true
50+
- type: textarea
51+
attributes:
52+
label: Specific requirements or considerations
53+
description: |
54+
Please provide any specific requirements or considerations that you have for this feature request.
55+
- type: textarea
56+
attributes:
57+
label: Additional information or context
58+
description: |
59+
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.

.github/ISSUE_TEMPLATE/d-enhancement-proposal.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Submit an enhancement proposal
2+
description: You have a proposal for code cleanup, a refactor, or other improvements.
3+
title: "[Enhancement proposal]: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to submit an enhancement proposal!
10+
Please take the time to fill out the information below so that we can better evaluate the need for the enhancement.
11+
- type: checkboxes
12+
attributes:
13+
label: Please check the following before submitting a new issue.
14+
options:
15+
- label: I have searched the [existing issues](https://github.com/baseflow/flutter-google-api-availability/issues).
16+
required: true
17+
- 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.
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Proposal
22+
description: |
23+
Please provide a clear and concise description of your proposed enhancement.
24+
25+
Please attach something showcasing your idea:
26+
* code samples
27+
* images
28+
* videos
29+
validations:
30+
required: true
31+
- type: textarea
32+
attributes:
33+
label: Pitch
34+
description: |
35+
How will this refactor enhance the lives of contributors?
36+
We would greatly appreciate it if you could provide us with as many details as possible.
37+
Specifically, please describe the specific benefits, improvements, or advantages that contributors can expect to experience as a result of this refactor.
38+
Your comprehensive input will help us better understand the impact and value of implementing this change.
39+
validations:
40+
required: true

.github/ISSUE_TEMPLATE/e-question.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)