From f310771702291be93e1c6b3bdb5a76e02fb8cae8 Mon Sep 17 00:00:00 2001 From: Sean Morley <98704938+seanmorley15@users.noreply.github.com> Date: Mon, 8 Sep 2025 22:38:08 -0400 Subject: [PATCH] Update issue templates for bug reports, deployment issues, and feature requests (#849) --- .github/ISSUE_TEMPLATE/bug_report.md | 64 +++++++++++++++------- .github/ISSUE_TEMPLATE/deployment-issue.md | 24 +++++--- .github/ISSUE_TEMPLATE/feature_request.md | 47 +++++++++++----- backend/server/.env.example | 4 +- 4 files changed, 95 insertions(+), 44 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dac71658..fd3f3bda 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,27 +1,49 @@ --- name: Bug report -about: Detailed bug reports help me diagnose and fix bugs quicker! Thanks! -title: "[BUG]" +about: Found something not working as expected? Please file a detailed bug report so we can fix it quickly! +title: "[BUG] " labels: bug -assignees: '' +assignees: "" +--- + +πŸ›‘ **Note**: Please search existing issues before filing a new one. This helps avoid duplicates and ensures we can address your concern efficiently! + +## 🐞 Bug Description + +A clear and concise description of the issue. What went wrong? + +## πŸ”„ Steps to Reproduce + +Steps to reproduce the behavior: + +1. +2. +3. +4. Observe the error + +## βœ… Expected Behavior + +What did you expect AdventureLog to do? + +## πŸ“Έ Screenshots / Logs + +- Attach screenshots if it helps explain the problem. +- If possible, include **relevant log excerpts** (be sure to remove sensitive info). + +## 🐳 Environment Details + +- **Platform:** (Docker, Synology, Proxmox, TrueNAS, Unraid, etc.) +- **Install Method:** (Docker Compose, Quick Install Script, Manual, etc.) +- **AdventureLog Version:** (e.g., v0.11.0) +- **Reverse Proxy:** (e.g., Nginx, Traefik, Caddy, etc. or None) + +If using Docker and the issue is related to the container, it may be helpful to include your `docker-compose.yml` or relevant variables below. +⚠️ Please remember to redact any sensitive information such as passwords or API keys. + +## πŸ“Ž Additional Context + +Anything else that might be useful (custom configuration, network setup, database version, etc.)? --- -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Docker Compose** -If the issue is related to deployment and docker, please post an **obfuscated** (remove secrets and confidential information) version of your compose file. - -**Additional context** -Add any other context about the problem here. +Thank you for taking the time to report this issue! We appreciate your help in making AdventureLog better. We’ll look into it as soon as we can. πŸ™Œ diff --git a/.github/ISSUE_TEMPLATE/deployment-issue.md b/.github/ISSUE_TEMPLATE/deployment-issue.md index fcc8228c..a926ed68 100644 --- a/.github/ISSUE_TEMPLATE/deployment-issue.md +++ b/.github/ISSUE_TEMPLATE/deployment-issue.md @@ -1,15 +1,25 @@ --- name: Deployment Issue -about: Request help deploying AdventureLog on your machine. The more details, the - better I can help! -title: "[DEPLOYMENT]" +about: Request help deploying AdventureLog. For faster support, please use our Discord community! +title: "[DEPLOYMENT] " labels: deployment -assignees: '' +assignees: "" +--- + +⚠️ **Note:** GitHub issues are primarily for tracking bugs and feature requests. +For general deployment troubleshooting and faster community support, please visit our **Discord**: https://discord.gg/wRbQ9Egr8C --- -## Explain your issue +## πŸ–₯️ Describe Your Issue -## Provide an **obfuscated** `docker-compose.yml` +A clear and concise description of the deployment problem. -## Provide any necessary logs from the containers and browser +## 🐳 Docker Compose (Obfuscated) + +Please include your `docker-compose.yml` or relevant variable configuration. +⚠️ Make sure to **remove or obfuscate sensitive information** (passwords, tokens, keys, etc.). + +```yaml +# Example (with secrets removed) +``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 696e895e..20ef0d38 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,39 @@ --- name: Feature request -about: Suggest an idea for AdventureLog -title: "[REQUEST]" +about: Suggest a new idea, feature, or improvement for AdventureLog +title: "[REQUEST] " labels: enhancement -assignees: '' +assignees: "" +--- + +πŸ›‘ **Note**: Please search existing issues before creating a new request. This helps avoid duplicates and keeps discussions focused. + +## πŸ’‘ Feature Summary + +A clear and concise description of the feature or improvement you’d like to see. + +## πŸ€” Problem Statement + +Is your request related to a specific problem? +(Example: β€œI’m always frustrated when…”) + +## πŸ› οΈ Proposed Solution + +Describe the solution you’d like. +What should AdventureLog do differently? + +## πŸ”„ Alternatives Considered + +List any alternative solutions or workarounds you’ve tried or thought about. + +## πŸ“Έ Mockups / Examples (optional) + +If you would like, include screenshots, sketches, or links that illustrate the idea. + +## πŸ“Ž Additional Context + +Any other details that might help us understand the request (use cases, user stories, related features, etc.). --- -**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 [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. +✨ Thanks for suggesting improvements to AdventureLog! Your ideas help shape the future of the project. diff --git a/backend/server/.env.example b/backend/server/.env.example index 18e05d0a..3246f9b9 100644 --- a/backend/server/.env.example +++ b/backend/server/.env.example @@ -42,6 +42,6 @@ EMAIL_BACKEND='console' # git fetch origin && git checkout development && git reset --hard origin/main && git push origin development --force # Pull and merge weblate changes -# git remote update weblate; -# git merge weblate/development; +# git fetch weblate +# git merge --squash weblate/development # ------------------- # \ No newline at end of file