From f45e904f2fe6d05e7142a0e1fd99f2abf4707eb4 Mon Sep 17 00:00:00 2001 From: Daniel Volz Date: Tue, 30 Dec 2025 14:05:56 +0100 Subject: [PATCH] docs: add GitHub issue templates - Bug report template with deployment type, browser info, logs - Feature request template with affected area, priority - Config with link to discussions and README - Optimize test.yml to skip tests for non-code changes --- .github/ISSUE_TEMPLATE/bug_report.yml | 78 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 8 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 77 +++++++++++++++++++++ .github/workflows/test.yml | 5 ++ 4 files changed, 168 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..12293a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,78 @@ +name: 🐛 Bug Report +description: Report a bug or unexpected behavior +labels: ["bug", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to report a bug! Please fill out the sections below. + + - type: textarea + id: description + attributes: + label: Bug Description + description: A clear and concise description of what the bug is. + placeholder: What happened? + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to Reproduce + description: How can we reproduce this issue? + placeholder: | + 1. Go to '...' + 2. Click on '...' + 3. See error + validations: + required: true + + - type: textarea + id: expected + attributes: + label: Expected Behavior + description: What did you expect to happen? + placeholder: What should have happened instead? + validations: + required: true + + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: If applicable, add screenshots to help explain your problem. + placeholder: Drag and drop images here + + - type: dropdown + id: deployment + attributes: + label: Deployment Type + description: How are you running MedAssist? + options: + - Docker Compose (Production) + - Docker Compose (Development) + - Local development (npm run dev) + - Other + validations: + required: true + + - type: input + id: browser + attributes: + label: Browser + description: What browser are you using? + placeholder: e.g. Chrome 120, Firefox 121, Safari 17 + + - type: textarea + id: logs + attributes: + label: Relevant Log Output + description: Please copy and paste any relevant log output (backend or browser console). + render: shell + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..bdb5dec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: true +contact_links: + - name: 💬 Discussions + url: https://github.com/DanielVolz/medassist-ng/discussions + about: Ask questions or share ideas in Discussions + - name: 📖 Documentation + url: https://github.com/DanielVolz/medassist-ng#readme + about: Check the README for setup and usage instructions diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..1b0e211 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,77 @@ +name: ✨ Feature Request +description: Suggest a new feature or improvement +labels: ["enhancement", "triage"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting an improvement! Please fill out the sections below. + + - type: textarea + id: problem + attributes: + label: Problem or Motivation + description: Is your feature request related to a problem? Please describe. + placeholder: I'm always frustrated when... + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: Describe the solution you'd like to see. + placeholder: A clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives + attributes: + label: Alternatives Considered + description: Describe any alternative solutions or features you've considered. + placeholder: Other approaches you thought about + + - type: dropdown + id: area + attributes: + label: Affected Area + description: Which part of the app does this affect? + options: + - Dashboard + - Medications + - Schedule / Timeline + - Planner + - Settings + - Notifications (Email/Push) + - Authentication + - Share functionality + - Mobile experience + - API / Backend + - Other + validations: + required: true + + - type: dropdown + id: priority + attributes: + label: Priority (your opinion) + description: How important is this feature to you? + options: + - Nice to have + - Would be helpful + - Important for my use case + - Critical / Blocking + + - type: textarea + id: mockups + attributes: + label: Mockups / Examples + description: If you have any mockups, screenshots, or examples from other apps, add them here. + placeholder: Drag and drop images here + + - type: textarea + id: additional + attributes: + label: Additional Context + description: Add any other context about the feature request here. diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index cc75234..6fcdb39 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -3,6 +3,11 @@ name: Test on: pull_request: branches: [main] + paths: + - 'backend/**' + - 'frontend/**' + - 'package*.json' + - '.github/workflows/test.yml' # Minimal permissions for security permissions: