diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..65d9f8d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,64 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: '' + +--- + +**Bug Description** +A clear description of the bug you encountered. + +**Reproduction Steps** +1. System state (e.g., 'Playing music', 'Idle') +2. Action taken (e.g., 'Used voice command "..."', 'Made gesture') +3. Error observed + +**Expected Behavior** +What should have happened? + +**System Information** +- Hardware: + - [ ] Raspberry Pi Zero 2W + - [ ] Other (specify): ___ +- OS Version: [e.g., Raspbian Bullseye] +- Python Version: [e.g., 3.11.x] +- FAM Version/Commit: [e.g., main branch commit hash] + +**Component Specific** +Check relevant components: +- [ ] Voice Control +- [ ] Gesture Detection +- [ ] Music Playback +- [ ] GPT Integration +- [ ] Game Server +- [ ] Bluetooth/Raspotify +- [ ] Task Management + +**Hardware Setup** +- Ultrasonic Sensor: + - Connected to GPIO pins: [specify pins] + - Distance from sensor: [e.g., 2-5cm] +- Audio Output: [e.g., 3.5mm, HDMI, Bluetooth] +- Other connected hardware: [specify] + +**Configuration** +- [ ] secrets.yaml properly configured +- [ ] All required API keys set +- [ ] Required directories exist +- [ ] Permissions correctly set + +**Error Output** +Paste any relevant error messages or logs here + +**Additional Context** +- Voice command used (if applicable): [e.g., "play music"] +- Music playing? [Yes/No] +- Network connected? [Yes/No] +- Other relevant details + +**Screenshots/Videos** +If applicable, add media to help explain your problem. + +Remember: Do NOT include any API keys or sensitive information in your report. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..c6e8773 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,63 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE REQUEST]" +labels: enhancement +assignees: '' + +--- + +**Feature Category** +- [ ] Voice Control +- [ ] Gesture Detection +- [ ] Music Playback +- [ ] GPT Integration +- [ ] Game Server +- [ ] Task Management +- [ ] Hardware Integration +- [ ] Other: ___ + +**Problem Statement** +What limitation or issue does this feature address? Example: "Currently unable to control volume using gestures..." + +**Proposed Solution** +Describe your feature idea in detail: +- Functionality: +- User interaction: +- Expected outcome: + +**Hardware Requirements** +Does this feature require: +- [ ] Additional sensors +- [ ] Different GPIO configuration +- [ ] More processing power +- [ ] Additional memory +- [ ] Network capabilities +- [ ] Audio equipment +- [ ] Other: ___ + +**Software Integration** +Would this feature interact with: +- [ ] Existing voice commands +- [ ] Gesture control system +- [ ] Music player +- [ ] GPT functionality +- [ ] Game server +- [ ] Task manager +- [ ] Other: ___ + +**Alternative Approaches** +What other solutions have you considered? + +**Implementation Complexity** +Your estimate of: +- Development effort: [Low/Medium/High] +- Hardware changes: [None/Minor/Major] +- Performance impact: [Low/Medium/High] + +**Additional Context** +- Diagrams/mockups (if any) +- Similar features in other projects +- Use case scenarios + +Remember: No API keys or sensitive information in feature requests.