summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAram Drevekenin <aram@poor.dev>2023-12-06 19:58:34 +0100
committerGitHub <noreply@github.com>2023-12-06 19:58:34 +0100
commit5eacf0bb509130ea63e401211fd041f8c1a65f16 (patch)
treee0cdd6b8c88375338d14218451ec8ecc2be6342c
parent6370a897ed7d379f48e6a97e0264886c27a4b889 (diff)
docs(repo): update issue templates
-rw-r--r--.github/ISSUE_TEMPLATE/blank_issue.md6
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md30
2 files changed, 28 insertions, 8 deletions
diff --git a/.github/ISSUE_TEMPLATE/blank_issue.md b/.github/ISSUE_TEMPLATE/blank_issue.md
index 9aef3ebe6..a08ad07cb 100644
--- a/.github/ISSUE_TEMPLATE/blank_issue.md
+++ b/.github/ISSUE_TEMPLATE/blank_issue.md
@@ -1,4 +1,10 @@
---
name: Blank Issue
about: Create a blank issue.
+title: ''
+labels: ''
+assignees: ''
+
---
+
+
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 5b11f2743..ff4b46e2e 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,11 +1,20 @@
---
name: "\U0001F41B Bug Report"
-about: "If something isn't working as expected."
+about: If something isn't working as expected.
+title: ''
labels: bug
+assignees: ''
+
---
-Thank you for taking the time to file this issue! Please follow the instructions and fill in the missing parts below the instructions, if it is meaningful. Try to be brief and concise.
-**In Case of Graphical or Performance Issues**
+Please choose the relevant section, follow the instructions and delete the other sections:
+
+1. Graphical issue inside a terminal pane (eg. something does not look as it should or as it looks outside of Zellij)
+2. Issues with the Zellij UI / behavior
+
+** Please note: comparisons of desired behavior to tmux are usually not relevant. tmux and Zellij are two extremely different entities that do things very differently. Zellij is not, nor does it try to be a tmux clone. Please try to refrain from such comparisons. **
+
+# 1. Graphical issue inside a terminal pane (eg. something does not look as it should)
1. Delete the contents of `/tmp/zellij-1000/zellij-log`, ie with `cd /tmp/zellij-1000/` and `rm -fr zellij-log/` (`/tmp/` is `$TMPDIR/` on OSX)
2. Run `zellij --debug`
@@ -18,12 +27,17 @@ Please attach the files that were created in `/tmp/zellij-1000/zellij-log/` to t
**Basic information**
`zellij --version`:
+
`stty size`:
-`uname -av` or `ver`(Windows):
-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)
+`uname -av` or `ver`(Windows):
-**Further information**
+## Further information
Reproduction steps, noticeable behavior, related issues, etc
+
+# 2. Issues with the Zellij UI / behavior
+Please find a minimal reproduction. If you have a complex setup that causes an issue, try to troubleshoot and narrow the problem down to as minimal a reproduction as possible. Remove as many parts of the equation as possible. If you are unsure what to do, you are welcome to ask for help either in the issue itself or in one of our community chats (Discord / Matrix). We will be happy to try and assist or suggest directions, but please note that the responsibility to troubleshoot the issue and find the problem is ultimately on your shoulders. Thank you for understanding.
+
+Example of a good issue report: "The `default_tab_template` layout node does not work when resurrecting sessions".
+
+Example of an issue report that needs work before being submitted: "Zellij randomly crashes without an error when I use it with the attached script".