From c42a9c84d7fc65449614086701e0cc84bd082bf0 Mon Sep 17 00:00:00 2001 From: inventory69 Date: Wed, 24 Dec 2025 00:00:43 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Improve=20issue=20templates=20with?= =?UTF-8?q?=20structured=20forms?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add proper GitHub Form templates with dropdowns and checkboxes - Bug report: Android version, app version, sync/battery optimization status - Feature request: Platform selection, priority, willingness to contribute - Question: Documentation checklist, topic selection, context fields - All forms bilingual (DE/EN) with app-specific questions [skip ci] --- .github/ISSUE_TEMPLATE/bug_report.yml | 187 +++++++++++++++------ .github/ISSUE_TEMPLATE/feature_request.yml | 121 ++++++++----- .github/ISSUE_TEMPLATE/question.yml | 98 ++++++++--- 3 files changed, 285 insertions(+), 121 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2e14b5b..c368df0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,61 +1,152 @@ ---- -name: Bug Report / Fehlerbericht -about: Melde einen Fehler in der App / Report a bug in the app -title: '[BUG] ' -labels: bug -assignees: '' +name: 🐛 Bug Report / Fehlerbericht +description: Melde einen Fehler in der App / Report a bug in the app +title: "[BUG] " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Danke für deinen Bug Report! / Thanks for reporting a bug! + + Bitte fülle alle relevanten Felder aus. / Please fill out all relevant fields. ---- + - type: textarea + id: description + attributes: + label: 🐛 Beschreibung / Description + description: Beschreibe den Fehler kurz und präzise / Describe the bug briefly and precisely + placeholder: "z.B. Auto-Sync funktioniert nicht mehr nach App-Update / e.g. Auto-sync stopped working after app update" + validations: + required: true -## 🐛 Beschreibung / Description + - type: dropdown + id: android-version + attributes: + label: 📱 Android Version + description: Welche Android Version verwendest du? / Which Android version are you using? + options: + - Android 14 + - Android 13 + - Android 12 + - Android 11 + - Android 10 + - Android 9 + - Android 8.1 + - Android 8.0 + - Andere / Other + validations: + required: true - + - type: input + id: app-version + attributes: + label: 📲 App Version + description: Welche Version der App verwendest du? (Einstellungen → Über) / Which app version? (Settings → About) + placeholder: "z.B. / e.g. v1.1.0" + validations: + required: true ---- + - type: input + id: device + attributes: + label: 📱 Gerät / Device + description: Welches Gerät verwendest du? / Which device are you using? + placeholder: "z.B. Samsung Galaxy S21, Google Pixel 7, etc." + validations: + required: false -## 📱 Systeminfo / System Info + - type: textarea + id: steps + attributes: + label: 🔄 Schritte zum Reproduzieren / Steps to Reproduce + description: Wie kann der Fehler reproduziert werden? / How can the bug be reproduced? + placeholder: | + 1. Öffne die App / Open the app + 2. Gehe zu Einstellungen / Go to settings + 3. Klicke auf ... / Click on ... + 4. Fehler tritt auf / Bug occurs + validations: + required: true -- **Android Version:** (z.B. / e.g. Android 13) -- **App Version:** (z.B. / e.g. v1.1.0) -- **Gerät / Device:** (z.B. / e.g. Samsung Galaxy S21) + - type: textarea + id: expected + attributes: + label: ✅ Erwartetes Verhalten / Expected Behavior + description: Was sollte passieren? / What should happen? + placeholder: "z.B. Notizen sollten alle 30 Min synchronisiert werden / e.g. Notes should sync every 30 min" + validations: + required: true ---- + - type: textarea + id: actual + attributes: + label: ❌ Tatsächliches Verhalten / Actual Behavior + description: Was passiert stattdessen? / What happens instead? + placeholder: "z.B. Sync funktioniert nicht, keine Notification / e.g. Sync doesn't work, no notification" + validations: + required: true -## 🔄 Schritte zum Reproduzieren / Steps to Reproduce + - type: dropdown + id: sync-enabled + attributes: + label: � Auto-Sync aktiviert? / Auto-Sync enabled? + options: + - "Ja / Yes" + - "Nein / No" + validations: + required: false -1. -2. -3. + - type: dropdown + id: battery-optimization + attributes: + label: 🔋 Akku-Optimierung deaktiviert? / Battery optimization disabled? + description: Einstellungen → Apps → Simple Notes → Akku → Nicht optimieren / Settings → Apps → Simple Notes → Battery → Don't optimize + options: + - "Ja, deaktiviert / Yes, disabled" + - "Nein, noch optimiert / No, still optimized" + - "Weiß nicht / Don't know" + validations: + required: false ---- + - type: textarea + id: server-config + attributes: + label: 🌐 Server-Konfiguration / Server Configuration + description: Falls relevant / If relevant (KEINE Passwörter! / NO passwords!) + placeholder: | + - Server läuft lokal / Server runs locally + - Docker auf Raspberry Pi / Docker on Raspberry Pi + - Gleiche WiFi / Same WiFi + - Server-IP: 192.168.x.x (erste 3 Zahlen reichen / first 3 numbers sufficient) + validations: + required: false -## ✅ Erwartetes Verhalten / Expected Behavior + - type: textarea + id: logs + attributes: + label: 📋 Logs / Screenshots + description: | + Falls vorhanden: Screenshots oder LogCat Output / If available: Screenshots or LogCat output + + LogCat Filter: `adb logcat -s SyncWorker NetworkMonitor WebDavSyncService` + placeholder: "Füge hier Logs oder Screenshots ein / Paste logs or screenshots here" + validations: + required: false - + - type: textarea + id: additional + attributes: + label: 🔧 Zusätzliche Informationen / Additional Context + description: Gibt es noch etwas, das wir wissen sollten? / Is there anything else we should know? + validations: + required: false ---- - -## ❌ Tatsächliches Verhalten / Actual Behavior - - - ---- - -## 📸 Screenshots / Logs - - - -
-LogCat (optional) - -``` -Füge hier LogCat Output ein / Paste LogCat output here -``` - -
- ---- - -## 🔧 Zusätzliche Informationen / Additional Context - - + - type: checkboxes + id: checklist + attributes: + label: ✅ Checklist + options: + - label: Ich habe die [Troubleshooting-Sektion](https://github.com/inventory69/simple-notes-sync/blob/main/QUICKSTART.md#troubleshooting) gelesen / I have read the troubleshooting section + required: false + - label: Ich habe "Verbindung testen" in den Einstellungen probiert / I have tried "Test connection" in settings + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 3c0154f..4e9c6df 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,53 +1,84 @@ ---- -name: Feature Request / Feature-Wunsch -about: Schlage eine neue Funktion vor / Suggest a new feature -title: '[FEATURE] ' -labels: enhancement -assignees: '' +name: 💡 Feature Request / Feature-Wunsch +description: Schlage eine neue Funktion vor / Suggest a new feature +title: "[FEATURE] " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Danke für deinen Feature-Vorschlag! / Thanks for your feature suggestion! ---- + - type: textarea + id: feature-description + attributes: + label: 💡 Feature-Beschreibung / Feature Description + description: Was möchtest du hinzugefügt haben? / What would you like to be added? + placeholder: "z.B. Notizen sollten Markdown-Formatierung unterstützen / e.g. Notes should support markdown formatting" + validations: + required: true -## 💡 Feature-Beschreibung / Feature Description + - type: textarea + id: problem + attributes: + label: 🎯 Problem / Motivation + description: Welches Problem würde dieses Feature lösen? / What problem would this feature solve? + placeholder: "z.B. Ich möchte Code-Snippets und Listen in meinen Notizen formatieren / e.g. I want to format code snippets and lists in my notes" + validations: + required: true - + - type: textarea + id: solution + attributes: + label: 📝 Vorgeschlagene Lösung / Proposed Solution + description: Wie könnte das Feature funktionieren? / How could the feature work? + placeholder: "z.B. Markdown-Editor mit Live-Preview / e.g. Markdown editor with live preview" + validations: + required: false ---- + - type: textarea + id: alternatives + attributes: + label: 🔄 Alternativen / Alternatives + description: Hast du andere Lösungsansätze in Betracht gezogen? / Have you considered other solutions? + validations: + required: false -## 🎯 Problem / Motivation + - type: dropdown + id: platform + attributes: + label: 📱 Plattform / Platform + description: Für welche Komponente ist das Feature? / For which component is the feature? + options: + - Android App + - WebDAV Server + - Dokumentation / Documentation + - Andere / Other + validations: + required: true - + - type: dropdown + id: priority + attributes: + label: 🌟 Priorität (aus deiner Sicht) / Priority (from your perspective) + options: + - Nice to have + - Wichtig / Important + - Sehr wichtig / Very important + validations: + required: false ---- + - type: checkboxes + id: willing-to-contribute + attributes: + label: 🤝 Beitragen / Contribute + options: + - label: Ich würde gerne bei der Implementierung helfen / I would like to help with implementation + required: false -## 📝 Vorgeschlagene Lösung / Proposed Solution - - - ---- - -## 🔄 Alternativen / Alternatives - - - ---- - -## 📱 Plattform / Platform - -- [ ] Android App -- [ ] WebDAV Server -- [ ] Dokumentation / Documentation -- [ ] Andere / Other: ___________ - ---- - -## 🌟 Priorität (aus deiner Sicht) / Priority (from your perspective) - -- [ ] Nice to have -- [ ] Wichtig / Important -- [ ] Kritisch / Critical - ---- - -## 🔧 Zusätzliche Informationen / Additional Context - - + - type: textarea + id: additional + attributes: + label: 🔧 Zusätzliche Informationen / Additional Context + description: Screenshots, Mockups, Links, ähnliche Apps, etc. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index d442d74..c3db225 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,34 +1,76 @@ ---- -name: Question / Frage -about: Stelle eine Frage zur Nutzung / Ask a question about usage -title: '[QUESTION] ' -labels: question -assignees: '' +name: ❓ Question / Frage +description: Stelle eine Frage zur Nutzung / Ask a question about usage +title: "[QUESTION] " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Hast du eine Frage? Wir helfen gerne! / Have a question? We're happy to help! ---- + - type: textarea + id: question + attributes: + label: ❓ Frage / Question + description: Was möchtest du wissen? / What would you like to know? + placeholder: "z.B. Wie kann ich die Sync-URL für einen externen Server konfigurieren? / e.g. How can I configure the sync URL for an external server?" + validations: + required: true -## ❓ Frage / Question + - type: checkboxes + id: documentation-checked + attributes: + label: 📚 Dokumentation gelesen / Documentation checked + description: Hast du bereits in der Dokumentation nachgeschaut? / Have you already checked the documentation? + options: + - label: Ich habe die [README](https://github.com/inventory69/simple-notes-sync/blob/main/README.md) gelesen / I have read the README + required: false + - label: Ich habe den [Quick Start Guide](https://github.com/inventory69/simple-notes-sync/blob/main/QUICKSTART.md) gelesen / I have read the Quick Start Guide + required: false + - label: Ich habe das [Troubleshooting](https://github.com/inventory69/simple-notes-sync/blob/main/QUICKSTART.md#troubleshooting) durchgearbeitet / I have checked the troubleshooting section + required: false - + - type: textarea + id: tried + attributes: + label: 🔍 Was hast du bereits versucht? / What have you already tried? + description: Hilf uns, dir besser zu helfen / Help us help you better + placeholder: "z.B. Ich habe versucht die Server-URL anzupassen, aber... / e.g. I tried adjusting the server URL, but..." + validations: + required: false ---- + - type: dropdown + id: topic + attributes: + label: � Thema / Topic + description: Um was geht es? / What is this about? + options: + - Server Setup / Server-Einrichtung + - App-Konfiguration / App configuration + - Sync-Probleme / Sync issues + - Netzwerk / Network + - Android-Einstellungen / Android settings + - Andere / Other + validations: + required: false -## 🔍 Was hast du bereits versucht? / What have you already tried? + - type: textarea + id: context + attributes: + label: � Kontext / Context + description: Zusätzliche Informationen die hilfreich sein könnten / Additional information that might be helpful + placeholder: | + - Android Version: Android 13 + - App Version: v1.1.0 + - Server: Raspberry Pi mit Docker / Raspberry Pi with Docker + - Netzwerk: Lokales WiFi / Local WiFi + validations: + required: false - - -- [ ] [Quick Start Guide](https://github.com/inventory69/simple-notes-sync/blob/main/QUICKSTART.md) gelesen / read -- [ ] [Troubleshooting](https://github.com/inventory69/simple-notes-sync/blob/main/QUICKSTART.md#troubleshooting) durchgearbeitet / checked -- [ ] [DOCS.md](https://github.com/inventory69/simple-notes-sync/blob/main/DOCS.md) gelesen / read - ---- - -## 📱 Kontext / Context - - - ---- - -## 🔧 Zusätzliche Informationen / Additional Information - - + - type: textarea + id: additional + attributes: + label: 🔧 Screenshots / Config + description: Falls hilfreich (KEINE Passwörter!) / If helpful (NO passwords!) + validations: + required: false