Skip to content

Commit 1c0d900

Browse files
JeroenWeenerJeroenWeener
authored
Merge pull request #8 from JeroenWeener/enhancement/add-github-templates
Add GitHub PR- and issue templates
2 parents 8aa5399 + 3e71d75 commit 1c0d900

7 files changed

Lines changed: 398 additions & 0 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: Baseflow
2+
custom: https://baseflow.com/contact

‎.github/ISSUE_TEMPLATE/a-regression.yml‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
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/baseflow_plugin_template/issues).
17+
required: true
18+
- type: checkboxes
19+
attributes:
20+
label: Please select affected platform(s)
21+
options:
22+
- label: Android
23+
- label: iOS
24+
- label: Linux
25+
- label: macOS
26+
- label: Web
27+
- label: Windows
28+
- type: textarea
29+
attributes:
30+
label: Old behavior
31+
description: |
32+
Please provide a brief and precise description of the functionality that the Baseflow plugin template plugin had before the regression occurred.
33+
Understanding the previous capabilities will assist us in pinpointing the changes and addressing the regression effectively.
34+
35+
Consider attaching something showing the old behavior:
36+
* code samples
37+
* images
38+
* videos
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Current behavior
44+
description: |
45+
Please provide a brief and precise description of the functionality that the Baseflow plugin template plugin has now.
46+
Understanding the current capabilities will assist us in pinpointing the changes and addressing the regression effectively.
47+
48+
Please attach something showing the current behavior:
49+
* code samples
50+
* images
51+
* videos
52+
validations:
53+
required: true
54+
- type: textarea
55+
attributes:
56+
label: Steps to reproduce
57+
description: Please provide specific steps to reproduce the situation in which the regression manifests.
58+
placeholder: |
59+
1. ...
60+
2. ...
61+
3. ...
62+
validations:
63+
required: true
64+
- type: textarea
65+
attributes:
66+
label: Code sample
67+
description: |
68+
Please create a minimal reproducible sample that shows the regression
69+
and attach it below between the lines with the backticks.
70+
71+
IMPORTANT: Please do not upload screenshots of text. Instead, use code blocks
72+
or the above mentioned ways to upload your code sample.
73+
value: |
74+
<details><summary>Code sample</summary>
75+
76+
```dart
77+
[Paste your code here]
78+
```
79+
80+
</details>
81+
validations:
82+
required: true
83+
- type: textarea
84+
attributes:
85+
label: Screenshots or video
86+
description: |
87+
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.
88+
value: |
89+
<details>
90+
<summary>Screenshots or video demonstration</summary>
91+
92+
[Upload media here]
93+
94+
</details>
95+
- type: input
96+
attributes:
97+
label: Current version
98+
description: Please specify which version of the plugin are you currently using.
99+
placeholder: ex. 1.2.3
100+
validations:
101+
required: true
102+
- type: input
103+
attributes:
104+
label: Last version without regression
105+
description: Please specify the version of the plugin in which the regression was not yet present.
106+
placeholder: ex. 1.2.2
107+
validations:
108+
required: true

‎.github/ISSUE_TEMPLATE/b-bug-report.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
name: Report a bug
2+
description: You encountered a bug in the Baseflow plugin template 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/baseflow_plugin_template/issues).
17+
- label: I have carefully [read the documentation](https://github.com/Baseflow/baseflow_plugin_template/blob/master/README.md) and verified I have added the required platform specific configuration.
18+
required: true
19+
- type: checkboxes
20+
attributes:
21+
label: Please select affected platform(s)
22+
options:
23+
- label: Android
24+
- label: iOS
25+
- label: Linux
26+
- label: macOS
27+
- label: Web
28+
- label: Windows
29+
- type: textarea
30+
attributes:
31+
label: Steps to reproduce
32+
description: Please provide specific steps to reproduce the issue.
33+
placeholder: |
34+
1. ...
35+
2. ...
36+
3. ...
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: Expected results
42+
description: Please provide a description of the expected behavior.
43+
validations:
44+
required: true
45+
- type: textarea
46+
attributes:
47+
label: Actual results
48+
description: Please provide a description of the current behavior.
49+
validations:
50+
required: true
51+
- type: textarea
52+
attributes:
53+
label: Code sample
54+
description: |
55+
Please create a minimal reproducible sample that shows the problem
56+
and attach it below between the lines with the backticks.
57+
58+
IMPORTANT: Please do not upload screenshots of text. Instead, use code blocks
59+
or the above mentioned ways to upload your code sample.
60+
value: |
61+
<details><summary>Code sample</summary>
62+
63+
```dart
64+
[Paste your code here]
65+
```
66+
67+
</details>
68+
validations:
69+
required: true
70+
- type: textarea
71+
attributes:
72+
label: Screenshots or video
73+
description: |
74+
Please consider uploading any relevant screenshots or videos showcasing the regression, if available.
75+
These visual aids can greatly assist us in understanding and addressing the issue more effectively.
76+
value: |
77+
<details>
78+
<summary>Screenshots or video demonstration</summary>
79+
80+
[Upload media here]
81+
82+
</details>
83+
- type: input
84+
id: version
85+
attributes:
86+
label: Version
87+
description: Please specify in which version of the plugin the bug occurs.
88+
placeholder: ex. 1.2.3
89+
validations:
90+
required: true
91+
- type: textarea
92+
attributes:
93+
label: Flutter Doctor output
94+
description: |
95+
Please provide the full output of running `flutter doctor -v`.
96+
value: |
97+
<details><summary>Doctor output</summary>
98+
99+
```console
100+
[Paste your output here]
101+
```
102+
103+
</details>
104+
validations:
105+
required: true

‎.github/ISSUE_TEMPLATE/c-feature-request.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
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/baseflow_plugin_template/issues).
23+
required: true
24+
- type: checkboxes
25+
attributes:
26+
label: Please select affected platform(s)
27+
options:
28+
- label: Android
29+
- label: iOS
30+
- label: Linux
31+
- label: macOS
32+
- label: Web
33+
- label: Windows
34+
- type: textarea
35+
attributes:
36+
label: Use case
37+
description: |
38+
We appreciate your feature request!
39+
In order to better understand your needs, please provide details regarding the problem you're encountering that prompted your desire for a new feature.
40+
41+
Is your feature request driven by a specific problem?
42+
Kindly provide a clear and concise description of the issue at hand.
43+
44+
Additionally, please share any alternative solutions you have considered.
45+
Have you explored existing packages on pub.dev that might already address this problem?
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: Proposal
51+
description: |
52+
Please provide a brief and precise description of the functionality that you are proposing.
53+
54+
Please attach something showing what you are imagining:
55+
* code samples
56+
* images
57+
* videos
58+
validations:
59+
required: true
60+
- type: textarea
61+
attributes:
62+
label: Specific requirements or considerations
63+
description: |
64+
Please provide any specific requirements or considerations that you have for this feature request.
65+
- type: textarea
66+
attributes:
67+
label: Additional information or context
68+
description: |
69+
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.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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/baseflow_plugin_template/issues).
16+
required: true
17+
- label: I have carefully [read the documentation](https://github.com/baseflow/baseflow_plugin_template/blob/master/README.md) and verified I have added the required platform specific configuration.
18+
required: true
19+
- type: checkboxes
20+
attributes:
21+
label: Please select affected platform(s)
22+
options:
23+
- label: Android
24+
- label: iOS
25+
- label: Linux
26+
- label: macOS
27+
- label: Web
28+
- label: Windows
29+
- type: textarea
30+
attributes:
31+
label: Proposal
32+
description: |
33+
Please provide a clear and concise description of your proposed enhancement.
34+
35+
Please attach something showcasing your idea:
36+
* code samples
37+
* images
38+
* videos
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Pitch
44+
description: |
45+
How will this refactor enhance the lives of contributors?
46+
We would greatly appreciate it if you could provide us with as many details as possible.
47+
Specifically, please describe the specific benefits, improvements, or advantages that contributors can expect to experience as a result of this refactor.
48+
Your comprehensive input will help us better understand the impact and value of implementing this change.
49+
validations:
50+
required: true

‎.github/ISSUE_TEMPLATE/e-question.yml‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Ask for help
2+
description: You have a question about the Baseflow plugin template plugin and are looking for help.
3+
title: "[Question]: "
4+
labels: ["needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We are happy to help you out!
10+
To help you effectively, we require some information. This will allow us to quickly understand your question.
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/baseflow_plugin_template/issues).
16+
required: true
17+
- label: I have carefully [read the documentation](https://github.com/baseflow/baseflow_plugin_template/blob/master/README.md).
18+
required: true
19+
- type: checkboxes
20+
attributes:
21+
label: Please select for which platform(s) you need help
22+
options:
23+
- label: Android
24+
- label: iOS
25+
- label: Linux
26+
- label: macOS
27+
- label: Web
28+
- label: Windows
29+
- type: textarea
30+
attributes:
31+
label: Your question
32+
description: |
33+
Please describe your question as detailed as possible.
34+
35+
Please attach something to help us understand your question:
36+
* code samples
37+
* images
38+
* videos
39+
validations:
40+
required: true
41+
- type: input
42+
id: version
43+
attributes:
44+
label: Version
45+
description: Please specify which version of the plugin are you currently using.
46+
placeholder: ex. 1.2.3
47+
validations:
48+
required: true

0 commit comments

Comments
 (0)