diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d0d0ea12b0..bdbe87a01c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,49 +8,48 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. - **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. +**Actual behavior** + +A clear and concise description of what happens instead; what the bug is. + **Screenshots** + If applicable, add screenshots to help explain your problem. **Desktop (please complete the following information):** - -- OS: (e.g. iOS) -- Browser (e.g. chrome, safari) -- Version (e.g. 22) +- OS (e.g. iOS): +- Browser & version (e.g. Chrome 89.0): **Smartphone (please complete the following information):** - -- Device: (e.g. iPhone6) -- OS: (e.g. iOS8.1) -- Browser (e.g. stock browser, safari) -- Version (e.g. 22) +- Device & model (e.g. iPhone 6): +- OS & version (e.g. iOS 8.1): +- Browser & version (e.g. stock browser 22): **Environment (please complete the following information):** -Specify if using SAAS (https://design.penpot.app) or self-hosted instance. +- Host (e.g. https://design.penpot.app, local instance): -If self-hosted instance, add OS and runtime information to help explain your problem. +*If self-hosted:* +- OS Version (e.g. Ubuntu 16.04): +- Docker / Docker-compose version (e.g. Docker version 18.03.0-ce, build 0520e24): +- Image version (e.g. Alpine): -- OS Version: (e.g. Ubuntu 16.04) +Docker commands or docker-compose file (if possible and if proceed.x): +``` -Also provide Docker commands or docker-compose file if possible and if proceed.x - -- Docker / Docker-compose Version: (e.g. Docker version 18.03.0-ce, build 0520e24) -- Image (e.g. alpine) - -**Frontend Stack Trace (if self-hosted)** +``` +Frontend Stack Trace:
``` @@ -59,8 +58,7 @@ Also provide Docker commands or docker-compose file if possible and if proceed.x
-**Backend Stack Trace (if self-hosted)** - +Backend Stack Trace:
``` @@ -69,5 +67,6 @@ Also provide Docker commands or docker-compose file if possible and if proceed.x
-**Additional context** -Add any other context about the problem here. +**Additional context:** + +Any other context about the problem.