Skip to content

Commit 60c6dfd

Browse files
committed
Merge branch 'feature/github_forms' into minor
2 parents 4124990 + 1a2c2c6 commit 60c6dfd

File tree

5 files changed

+265
-4
lines changed

5 files changed

+265
-4
lines changed
Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
name: Report a runtime bug
2+
description: You found a bug that happens during runtime.
3+
labels: ["1 backlog", "bug"]
4+
assignees: ["ryanheise"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a bug report.
10+
11+
Before doing so, please ensure that you have:
12+
13+
- read [CONTRIBUTING.md](https://github.com/ryanheise/audio_service/blob/minor/CONTRIBUTING.md)
14+
- searched for existing issues
15+
- confirmed you are using the plugin correctly according to its documentation
16+
- type: checkboxes
17+
attributes:
18+
label: Platforms exhibiting the bug
19+
description: |
20+
Please select the platforms exhibiting the bug.
21+
For other platforms, please submit your issue to the plugin for that platform.
22+
options:
23+
- label: Android
24+
- label: iOS
25+
- label: web
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Devices exhibiting the bug
31+
description: Please list which devices experienced the bug.
32+
placeholder: |
33+
1. ...
34+
2. ...
35+
3. ...
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Minimal reproduction project
41+
description: |
42+
Please fork this repository and make minimal changes to the official example to reproduce the bug.
43+
Paste the URL to your fork below between the backticks.
44+
If you modify only one file, you may instead paste just the contents of that one file.
45+
If the bug is reproducible with the unmodified official example, just put the pathname of that example.
46+
value: |
47+
<details open><summary>Minimal reproduction project</summary>
48+
49+
```dart
50+
[Paste here]
51+
```
52+
53+
</details>
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Steps to reproduce
59+
description: After I run your project, what steps should I follow to see the error?
60+
placeholder: |
61+
1. ...
62+
2. ...
63+
3. ...
64+
validations:
65+
required: true
66+
- type: textarea
67+
attributes:
68+
label: Expected results
69+
description: |
70+
Please describe what is expected to happen and why.
71+
validations:
72+
required: true
73+
- type: textarea
74+
attributes:
75+
label: Actual results
76+
description: Please describe what is actually happening.
77+
validations:
78+
required: true
79+
- type: textarea
80+
attributes:
81+
label: Screenshots or Video
82+
description: |
83+
Upload any screenshots or video of the bug if applicable.
84+
value: |
85+
<details open>
86+
<summary>Screenshots / Video demonstration</summary>
87+
88+
[Upload media here]
89+
90+
</details>
91+
- type: textarea
92+
attributes:
93+
label: Logs
94+
description: |
95+
Please copy and paste the complete log of the error within the backticks below, IN TEXT FORMAT.
96+
value: |
97+
<details open><summary>Logs</summary>
98+
99+
```console
100+
[Paste here]
101+
```
102+
103+
</details>
104+
- type: textarea
105+
attributes:
106+
label: Flutter Doctor output
107+
description: |
108+
Please copy and paste the output of `flutter doctor`
109+
value: |
110+
<details open><summary>Doctor output</summary>
111+
112+
```console
113+
[Paste here]
114+
```
115+
116+
</details>
117+
validations:
118+
required: true
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
name: Report a compile time bug
2+
description: You found a bug that occurs at compile time.
3+
labels: ["1 backlog", "bug"]
4+
assignees: ["ryanheise"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a bug report.
10+
11+
Before doing so, please ensure that you have:
12+
13+
- read [CONTRIBUTING.md](https://github.com/ryanheise/audio_service/blob/minor/CONTRIBUTING.md)
14+
- searched for existing issues
15+
- confirmed you are using the plugin correctly according to its documentation
16+
- type: checkboxes
17+
attributes:
18+
label: Platforms exhibiting the bug
19+
description: |
20+
Please select the platforms exhibiting the bug.
21+
For other platforms, please submit your issue to the plugin for that platform.
22+
options:
23+
- label: Android
24+
- label: iOS
25+
- label: web
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Devices exhibiting the bug
31+
description: Please list which devices experienced the bug.
32+
placeholder: |
33+
1. ...
34+
2. ...
35+
3. ...
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Minimal reproduction project
41+
description: |
42+
Please fork this repository and make minimal changes to the official example to reproduce the bug.
43+
Paste the URL to your fork below between the backticks.
44+
If you modify only one file, you may instead paste just the contents of that one file.
45+
If the bug is reproducible with the unmodified official example, just put the pathname of that example.
46+
value: |
47+
<details open><summary>Minimal reproduction project</summary>
48+
49+
```dart
50+
[Paste here]
51+
```
52+
53+
</details>
54+
validations:
55+
required: true
56+
- type: textarea
57+
attributes:
58+
label: Steps to reproduce
59+
description: After I copy your project, what steps should I follow to see the error?
60+
placeholder: |
61+
1. ...
62+
2. ...
63+
3. ...
64+
validations:
65+
required: true
66+
- type: textarea
67+
attributes:
68+
label: Error output
69+
description: |
70+
Please copy and paste the complete log of the build process, including the build command,
71+
within the backticks below, IN TEXT FORMAT.
72+
value: |
73+
<details open><summary>Logs</summary>
74+
75+
```console
76+
[Paste here]
77+
```
78+
79+
</details>
80+
- type: textarea
81+
attributes:
82+
label: Flutter Doctor output
83+
description: |
84+
Please copy and paste the output of `flutter doctor`
85+
value: |
86+
<details open><summary>Doctor output</summary>
87+
88+
```console
89+
[Paste here]
90+
```
91+
92+
</details>
93+
validations:
94+
required: true

.github/ISSUE_TEMPLATE/3_feature.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Feature request
2+
description: Suggest a new idea for this project.
3+
labels: ["1 backlog", "enhancement"]
4+
assignees: ["ryanheise"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for submitting a feature request.
10+
11+
Before doing so, please ensure that you have:
12+
13+
- searched for existing feature requests
14+
- confirmed that the feature does not already exist in the documentation
15+
- type: textarea
16+
attributes:
17+
label: Use case
18+
description: |
19+
Please describe the scenario in which this feature would be useful
20+
along with alternative solutions you've considered.
21+
validations:
22+
required: true
23+
- type: textarea
24+
attributes:
25+
label: Proposal
26+
description: |
27+
Please outline the solution you have in mind, including specific API calls.
28+
validations:
29+
required: true
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Documentation request
2+
description: Suggest an improvement to the documentation.
3+
labels: ["1 backlog", "documentation"]
4+
assignees: ["ryanheise"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for suggesting an improvement to the documentation.
10+
- type: input
11+
attributes:
12+
label: Documentation link
13+
description: |
14+
Paste the URL of the documentation page that your suggestion applies to.
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: Your suggestion
20+
description: |
21+
Please describe the proposed improvement below.
22+
validations:
23+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: I need help using audio_service
3+
- name: I need help
44
url: https://stackoverflow.com/questions/tagged/audio-service
55
about: Ask a for help on how to achieve a particular use case.
6-
- name: Submit a new issue (should not be used to ask for help)
7-
url: https://ryanheise.github.io/audio_service/issue-form/issue.html
8-
about: Before contributing an issue, be sure you have read CONTRIBUTING.md.

0 commit comments

Comments
 (0)