summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authormatu3ba <matu3ba@users.noreply.github.com>2021-05-10 14:13:26 +0200
committerGitHub <noreply@github.com>2021-05-10 14:13:26 +0200
commit2f1bba753a6b5a4f5850c5dc45dd8ba6c79dc8ed (patch)
tree845410fdb4819714f9cc796beed0234b80d70503 /.github
parent2cd433d0d6a43e0b774ee212fc3c95743a520460 (diff)
improve bug report template (#466)
Give copy-paste commands and give example of typical information and density. Refer to common sense of the issue author.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index d3b681273..fd34b4f95 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -3,27 +3,27 @@ name: "\U0001F41B Bug Report"
about: "If something isn't working as expected."
labels: bug
---
-Thank you for taking the time to file an issue!
-You can erase any parts of this template not applicable to your issue.
+Thank you for taking the time to file this issue! Please follow the instructions and fill the missing parts below the instructions, if it is meaningful. Try to be brief and concise.
-## In Case of Graphical, or Performance Issues
+**In Case of Graphical or Performance Issues**
-Please:
-1. Delete the contents of `/tmp/zellij-1000/zellij-log`.
-2. Run `zellij --debug` and then recreate your issue.
+1. Delete the contents of `/tmp/zellij-1000/zellij-log`, ie with `cd /tmp/zellij-1000/` and `rm -fr zellij-log/`
+2. Run `zellij --debug`
+3. Recreate your issue.
3. Quit Zellij immediately with ctrl-q (your bug should ideally still be visible on screen)
-Please attach the files that were created in
+Please attach the files that were created in `/tmp/zellij-1000/zellij-log/` to the extent you are comfortable with.
-`/tmp/zellij-1000/zellij-log/`
+**Basic information**
-To the extent you are comfortable with.
-
-Also please add the size in columns/lines of the terminal in which the bug happened. You can usually find these out with `tput lines` and `tput cols`.
-
-And the name and version of progams you interacted with as well as
-the operating system.
+`zellij --version`:
+`tput lines`:
+`tput cols`:
+`uname -av` or `ver`(Windows):
-## Information
+List of programs you interact with as, `PROGRAM --version`: output cropped meaningful, for example:
+`nvim --version`: NVIM v0.5.0-dev+1299-g1c2e504d5 (used the appimage release)
+`alacritty --version`: alacritty 0.7.2 (5ac8060b)
-`zellij --version`:
+**Further information**
+Reproduction steps, noticable behavior, related issues etc