Update issue templates for bug reports, deployment issues, and feature requests (#849)

This commit is contained in:
Sean Morley
2025-09-08 22:38:08 -04:00
committed by GitHub
parent 88cecd6365
commit c06c2a7523
4 changed files with 95 additions and 44 deletions

View File

@@ -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] <short description>"
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. Well look into it as soon as we can. 🙌

View File

@@ -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] <short description>"
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)
```

View File

@@ -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] <short description>"
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 youd like to see.
## 🤔 Problem Statement
Is your request related to a specific problem?
(Example: “Im always frustrated when…”)
## 🛠️ Proposed Solution
Describe the solution youd like.
What should AdventureLog do differently?
## 🔄 Alternatives Considered
List any alternative solutions or workarounds youve 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.

View File

@@ -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
# ------------------- #