Skip to content

Commit cd2aa6d

Browse files
authored
feat: add issue templates for bug reports and feature requests (#101)
1 parent 5ff6937 commit cd2aa6d

File tree

3 files changed

+401
-0
lines changed

3 files changed

+401
-0
lines changed
Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
name: 🐛 Bug Report
2+
description: Report a bug or issue with internet_connection_checker_plus
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report this bug! Please provide as much detail as possible to help us investigate and fix the issue quickly.
10+
11+
**Before submitting**, please search for existing issues to avoid duplicates.
12+
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Is there an existing issue for this?
17+
description: Please search to see if an issue already exists for the bug you encountered.
18+
options:
19+
- label: I have searched the existing issues
20+
required: true
21+
22+
- type: textarea
23+
id: description
24+
attributes:
25+
label: Bug Description
26+
description: A clear and concise description of what the bug is.
27+
placeholder: Describe what happened and what you expected to happen...
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: steps_to_reproduce
33+
attributes:
34+
label: Steps to Reproduce
35+
description: Detailed steps to reproduce the behavior
36+
placeholder: |
37+
1. Go to '...'
38+
2. Click on '...'
39+
3. Scroll down to '...'
40+
4. See error
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: expected_behavior
46+
attributes:
47+
label: Expected Behavior
48+
description: A clear and concise description of what you expected to happen.
49+
placeholder: What should have happened instead?
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: actual_behavior
55+
attributes:
56+
label: Actual Behavior
57+
description: What actually happened instead?
58+
placeholder: What actually happened?
59+
validations:
60+
required: true
61+
62+
- type: input
63+
id: package_version
64+
attributes:
65+
label: Package Version
66+
description: Which version of internet_connection_checker_plus are you using?
67+
placeholder: "e.g., 2.0.0"
68+
validations:
69+
required: true
70+
71+
- type: dropdown
72+
id: platforms
73+
attributes:
74+
label: Platform(s)
75+
description: Which platform(s) are affected?
76+
multiple: true
77+
options:
78+
- Android
79+
- iOS
80+
- Web
81+
- Windows
82+
- macOS
83+
- Linux
84+
validations:
85+
required: true
86+
87+
- type: dropdown
88+
id: flutter_channel
89+
attributes:
90+
label: Flutter Channel
91+
description: Which Flutter channel are you using?
92+
options:
93+
- stable
94+
- beta
95+
- master/main
96+
- unknown
97+
validations:
98+
required: true
99+
100+
- type: textarea
101+
id: flutter_doctor
102+
attributes:
103+
label: Flutter Doctor Output
104+
description: |
105+
Please run `flutter doctor -v` and paste the complete output below.
106+
This helps us understand your development environment.
107+
placeholder: Paste the output of `flutter doctor -v` here...
108+
render: shell
109+
validations:
110+
required: true
111+
112+
- type: textarea
113+
id: sample_code
114+
attributes:
115+
label: Minimal Reproduction Code
116+
description: |
117+
Please provide a minimal, complete, and verifiable example that reproduces the issue.
118+
This is crucial for us to debug the problem effectively.
119+
120+
**Note:** Remove any sensitive information like API keys or personal data.
121+
placeholder: |
122+
```dart
123+
// Paste your minimal reproduction code here
124+
import 'package:flutter/material.dart';
125+
import 'package:internet_connection_checker_plus/internet_connection_checker_plus.dart';
126+
127+
// Your code that reproduces the issue...
128+
```
129+
render: dart
130+
validations:
131+
required: true
132+
133+
- type: textarea
134+
id: logs
135+
attributes:
136+
label: Relevant Log Output
137+
description: |
138+
Please copy and paste any relevant log output. This will be automatically formatted into code.
139+
Include console output, error messages, stack traces, etc.
140+
placeholder: Paste your log output here...
141+
render: shell
142+
143+
- type: textarea
144+
id: device_info
145+
attributes:
146+
label: Device/Network Information
147+
description: |
148+
Please provide details about the device(s) and network conditions where the issue occurs.
149+
placeholder: |
150+
**Device Model:** (e.g., iPhone 14, Pixel 7, etc.)
151+
**OS Version:** (e.g., iOS 16.1, Android 13, etc.)
152+
**Network Type:** (e.g., Wi-Fi, Mobile Data, etc.)
153+
**ISP/Network Provider:** (if relevant)
154+
**Browser (if Web):** (e.g., Chrome 108, Safari 16, etc.)
155+
render: markdown
156+
157+
- type: textarea
158+
id: additional_context
159+
attributes:
160+
label: Additional Context
161+
description: |
162+
Add any other context about the problem here. Screenshots, video recordings,
163+
or links to similar issues can be very helpful.
164+
165+
**Tip:** You can attach images or files by clicking this area to highlight it and then dragging files in.
166+
placeholder: Any additional information that might help us understand the issue better...
167+
168+
- type: checkboxes
169+
id: volunteer
170+
attributes:
171+
label: Would you like to work on this issue?
172+
description: |
173+
We welcome contributions! If you're interested in working on this issue, let us know.
174+
Check out our [contribution guide](../CONTRIBUTING.md) for more information.
175+
options:
176+
- label: I'm interested in working on this issue
177+
required: false

.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: 📚 Documentation & Getting Started
4+
url: https://github.com/OutdatedGuy/internet_connection_checker_plus/blob/main/README.md
5+
about: Check out our comprehensive documentation and getting started guide
6+
- name: 💬 Community Discussion
7+
url: https://github.com/OutdatedGuy/internet_connection_checker_plus/discussions
8+
about: Ask questions, share ideas, and discuss with the community
9+
- name: 🆘 Need Help?
10+
url: https://stackoverflow.com/questions/tagged/flutter+internet-connection
11+
about: Get help from the Flutter community on Stack Overflow

0 commit comments

Comments
 (0)