From 324936525bf686f488b484e04db8d256bd0dbe28 Mon Sep 17 00:00:00 2001 From: bjornoleh <63544115+bjornoleh@users.noreply.github.com> Date: Thu, 30 May 2024 23:25:38 +0200 Subject: [PATCH] Merge pull request #202 from Sjoerd-Bo3/feat/issue-templates Update(issue templates): More readable styling and expansion of questions --- .github/ISSUE_TEMPLATE/bug-report.md | 59 +++++++++++++++-------- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.md | 26 +++++++--- 3 files changed, 59 insertions(+), 28 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 5b34e25d4..3ca47b578 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,31 +1,52 @@ --- name: "\U0001F41B Bug report" about: Create a report to help us fix things +title: '' +labels: ['bug', 'needs-triage'] +assignees: '' +projects: ['nightscout/2'] --- +## Describe the bug +*A clear and concise description of what the bug is. Describe what you see versus what you expect to see.* -**Describe the bug** -A clear and concise description of what the bug is. +## Attach a Log +*Tap the Trio settings icon at the bottom of the screen, then tap 'Share logs' on the bottom of the list and attach it to this ticket.* -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +## To Reproduce +*Steps to reproduce the behavior:* +1. *Go to '...'* +2. *Click on '....'* +3. *Scroll down to '....'* +4. *See error* -**Expected behavior** -A clear and concise description of what you expected to happen. +## Expected behavior +*A clear and concise description of what you expected to happen.* -**Screenshots** -If applicable, add screenshots to help explain your problem. +## Screenshots +*If applicable, add screenshots to help explain your problem.* -**Smartphone (please complete the following information):** +## Setup Information (please complete the following information): -**Setup Information (please complete the following information):** -* Pump type -* CGM type and CGM app -* Trio version, branch and git reference (see Trio Settings) +### Smartphone: +* Hardware: *[e.g. iPhone 15 Pro]* +* OS Version: *[e.g. iOS 17.5]* -**Additional context** -Add any other context about the problem here. +### Pump: +* Manufacturer: *[e.g. Insulet]* +* Model: *[e.g. Omnipod Dash or Eros]* + +### CGM: +* Device: *[e.g. Dexcom G7]* +* Manager app: *[e.g. Dexcom App or xDrip4iOS]* + +### Trio Version: +* Version Number: *[e.g. 1.9.2]* +* Repo: *nightscout/trio* +* Git Reference: *[e.g. commit hash]* + +## Technical Details +*If applicable, provide any technical details that might help in diagnosing the problem. This could include logs, error messages, or relevant configuration details.* + +## Additional context +*Add any other context about the problem here.* diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 84a512ca4..44330e16b 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: "🆘 Individual troubleshooting help: Please go to the Discord Trio Server" - url: https://discord.gg/fCY5svg4 + url: https://discord.com/invite/FnwFEFUwXE about: Are you having an issue with your individual setup? Please first go to the Discord Trio Server and post there, with details of your setup (App version, pump, CGM, and CGM app) and the issue you are observing diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index fe0989ed8..de0a0edce 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,17 +1,27 @@ --- name: "\U0001F4A1 Feature request \U0001F4A1" about: Suggest an idea for this project +title: '' +labels: ['enhancement', 'needs-triage'] +assignees: '' +projects: ['nightscout/2'] --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +## Is your feature request related to a problem? Please describe. +*Provide a clear and concise description of the problem. Explain how this issue affects your experience with the Trio app and any specific scenarios where it occurs.* -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Describe the solution you'd like +*Detail the desired change or feature you'd like to see implemented in the Trio app. Be specific about how this solution would improve your experience and address the problem described above.* -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Describe alternatives you've considered +*List and describe any alternative solutions or features you've considered that could also address the problem. Explain why you believe the proposed solution is the best option.* -**Additional context** -Add any other context or screenshots about the feature request here. +## Additional context +*Include any other context, screenshots, or relevant information that might help in understanding the issue or the proposed solution. If applicable, describe any previous discussions or decisions that relate to this feature request.* + +## Technical Details +*If applicable, provide any technical details or considerations that might impact the implementation of this feature. This could include dependencies, potential risks, or required changes to existing functionalities.* + +## User Impact +*(Optional) Describe the impact of this issue on your use of the Trio app. Include any specific examples or data that demonstrate how widespread or severe the problem is.*