diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index f618cc38..7a907ae2 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -7,25 +7,39 @@ assignees: '' --- -### Describe the bug +[//]: # (Hello and thank you for taking the time to submit a bug report! ) -A clear and concise description of what the bug is. +[//]: # (To make sure we can resolve this as quickly as possible, please ) +[//]: # (carefully fill out the information requested on this template. ) + +[//]: # (Hint: Lines that look like these are Markdown comments and won't be ) +[//]: # ( visible on the issue after you submit it so you don't need to ) +[//]: # ( delete them. ) + +### Description + +[//]: # (A clear and concise description of what the bug is and what you ) +[//]: # (expected to happen instead. Feel free to include additional material ) +[//]: # (such as screenshots if they contribute to the explanation. ) ### To Reproduce -Steps to reproduce the behavior: +[//]: # (A list of steps we can follow to consistently reproduce the bug ) + +### Context -1. Use version ... -2. +[//]: # (Please fill out the following list ) -### Expected behavior +> My operating system is: -A clear and concise description of what you expected to happen. +> Running `viv --version` outputs: -### Screenshots +```txt +output goes here +``` -If applicable, add screenshots to help explain your problem. +> I installed Vivify in the following way (e.g. name of the package manager, self-compiled or development mode): -### Additional context +> This is what happens when I run `vivify-server` at the absolute installation path instead of `viv` and try to reproduce the problem: -Add any other context about the problem here. +> In the following I specify if I use any custom configuration, and if so provide it in its entirety including any additional files referenced there (e.g. CSS or JavaScript):