Skip to content

Commit e0594a2

Browse files
committed
Add discussion templates
1 parent ab1a652 commit e0594a2

File tree

11 files changed

+881
-170
lines changed

11 files changed

+881
-170
lines changed
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
title: "💬 General Discussion"
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
Thank you for starting a discussion! This template helps structure general discussions about the KM271-WiFi project.
7+
8+
- type: input
9+
id: topic
10+
attributes:
11+
label: "🎯 Discussion Topic"
12+
description: "What would you like to discuss?"
13+
placeholder: "Brief summary of your discussion topic"
14+
validations:
15+
required: true
16+
17+
- type: checkboxes
18+
id: category
19+
attributes:
20+
label: "📋 Category"
21+
description: "Check the most relevant category"
22+
options:
23+
- label: "🔧 Hardware Design"
24+
- label: "💻 Software/Firmware"
25+
- label: "📚 Documentation"
26+
- label: "🏠 Integration with Heating Systems"
27+
- label: "🏭 Manufacturing/Production"
28+
- label: "🤝 Community/Project Direction"
29+
- label: "🆘 Help/Support Request"
30+
- label: "💡 Ideas/Brainstorming"
31+
32+
- type: textarea
33+
id: background
34+
attributes:
35+
label: "🔍 Background/Context"
36+
description: "Provide context for your discussion"
37+
placeholder: "Share relevant background information that helps others understand your discussion topic"
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: questions
43+
attributes:
44+
label: "❓ Questions/Points for Discussion"
45+
description: "What specific questions or points would you like to discuss?"
46+
placeholder: |
47+
1. Your first question or point
48+
2. Your second question or point
49+
3. Additional questions or discussion points
50+
validations:
51+
required: true
52+
53+
- type: textarea
54+
id: thoughts
55+
attributes:
56+
label: "💭 Your Thoughts/Opinions"
57+
description: "Share your perspective on the topic"
58+
placeholder: "What are your initial thoughts or opinions on this topic?"
59+
60+
- type: textarea
61+
id: references
62+
attributes:
63+
label: "📚 References/Links"
64+
description: "Any relevant links or documentation"
65+
placeholder: "Include links to relevant documentation, similar projects, or resources"
66+
67+
- type: checkboxes
68+
id: looking_for
69+
attributes:
70+
label: "🤝 Looking For"
71+
description: "What kind of engagement are you seeking?"
72+
options:
73+
- label: "Community feedback"
74+
- label: "Technical advice"
75+
- label: "Collaboration partners"
76+
- label: "Testing volunteers"
77+
- label: "General discussion"
78+
79+
- type: textarea
80+
id: additional
81+
attributes:
82+
label: "📋 Additional Information"
83+
description: "Any other relevant information"
84+
placeholder: "Include any other details that might be helpful for the discussion"

.github/DISCUSSION_TEMPLATE/general_discussion.md

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

.github/DISCUSSION_TEMPLATE/hardware_production.md

Lines changed: 0 additions & 59 deletions
This file was deleted.
Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
title: "🆘 Help & Support"
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
🤝 **Need help with your KM271-WiFi?**
7+
8+
This template helps you provide the information needed for the community to assist you effectively.
9+
10+
**Community Guidelines:**
11+
- Be patient - volunteers help in their free time
12+
- Provide clear information to get better help
13+
- Search existing discussions first
14+
- Consider contributing back once your issue is resolved
15+
16+
- type: textarea
17+
id: help_needed
18+
attributes:
19+
label: "🎯 What Do You Need Help With?"
20+
description: "Clear description of what you're trying to achieve or the problem you're facing"
21+
placeholder: "Describe your issue or what you're trying to accomplish"
22+
validations:
23+
required: true
24+
25+
- type: checkboxes
26+
id: help_category
27+
attributes:
28+
label: "📋 Help Category"
29+
description: "Select the primary area where you need assistance"
30+
options:
31+
- label: "🔧 Hardware Assembly"
32+
- label: "⚡ Electrical Issues"
33+
- label: "💻 Software Configuration"
34+
- label: "🏠 Heating System Integration"
35+
- label: "🔌 ESPHome Setup"
36+
- label: "📱 Home Assistant Integration"
37+
- label: "🌐 Network/WiFi Issues"
38+
- label: "🛠️ Troubleshooting"
39+
40+
- type: input
41+
id: hardware_version
42+
attributes:
43+
label: "🏷️ Hardware Version"
44+
description: "Which version of KM271-WiFi are you using?"
45+
placeholder: "e.g., KM271-WiFi v0.1.0"
46+
validations:
47+
required: true
48+
49+
- type: input
50+
id: buderus_controller
51+
attributes:
52+
label: "🏠 Buderus Controller"
53+
description: "What Buderus controller are you connecting to?"
54+
placeholder: "e.g., Logamatic 2107M"
55+
validations:
56+
required: true
57+
58+
- type: input
59+
id: esphome_version
60+
attributes:
61+
label: "💻 ESPHome Version"
62+
description: "Which ESPHome version are you using?"
63+
placeholder: "e.g., 2024.7.3"
64+
65+
- type: input
66+
id: ha_version
67+
attributes:
68+
label: "📱 Home Assistant Version (if applicable)"
69+
description: "Which Home Assistant version are you using?"
70+
placeholder: "e.g., 2024.7.4"
71+
72+
- type: textarea
73+
id: current_situation
74+
attributes:
75+
label: "🔍 Current Situation"
76+
description: "Describe your current setup and what's working/not working"
77+
placeholder: "Explain what you have set up so far and where you're encountering problems"
78+
validations:
79+
required: true
80+
81+
- type: textarea
82+
id: specific_problem
83+
attributes:
84+
label: "❗ Specific Problem"
85+
description: "What exactly isn't working?"
86+
placeholder: "Be as specific as possible about the issue you're experiencing"
87+
validations:
88+
required: true
89+
90+
- type: checkboxes
91+
id: steps_tried
92+
attributes:
93+
label: "🔄 Steps Already Tried"
94+
description: "What have you already attempted?"
95+
options:
96+
- label: "Checked documentation"
97+
- label: "Verified wiring/connections"
98+
- label: "Checked power supply"
99+
- label: "Reviewed logs/error messages"
100+
- label: "Searched existing issues/discussions"
101+
- label: "Restarted/power cycled the device"
102+
- label: "Tried different network settings"
103+
104+
- type: textarea
105+
id: other_steps
106+
attributes:
107+
label: "Other steps tried"
108+
description: "Describe any other troubleshooting steps you've attempted"
109+
placeholder: "List any other solutions you've tried that aren't mentioned above"
110+
111+
- type: textarea
112+
id: error_messages
113+
attributes:
114+
label: "📊 Error Messages/Logs"
115+
description: "Include any error messages, log files, or diagnostic information"
116+
placeholder: "Paste error messages, ESPHome logs, or other diagnostic output here"
117+
render: text
118+
119+
- type: textarea
120+
id: expected_behavior
121+
attributes:
122+
label: "🎯 Expected Behavior"
123+
description: "What should happen instead?"
124+
placeholder: "Describe what you expect to happen when everything is working correctly"
125+
126+
- type: dropdown
127+
id: urgency
128+
attributes:
129+
label: "⏰ Urgency"
130+
description: "How urgent is this issue?"
131+
options:
132+
- "Not urgent - when you have time"
133+
- "Moderately urgent - within a few days"
134+
- "Urgent - heating system not working"
135+
- "Emergency - no heat in winter!"
136+
validations:
137+
required: true
138+
139+
- type: textarea
140+
id: photos_description
141+
attributes:
142+
label: "📷 Photos/Screenshots"
143+
description: "Visual information often helps diagnose issues (attach files below)"
144+
placeholder: "Describe what photos or screenshots you're sharing: wiring, error screens, device setup, etc."
145+
146+
- type: textarea
147+
id: additional_context
148+
attributes:
149+
label: "💡 Additional Context"
150+
description: "Any other relevant information"
151+
placeholder: "Include any other details that might help diagnose the issue: recent changes, environmental factors, related problems, etc."

0 commit comments

Comments
 (0)