Skip to content

Commit 6cd2c7e

Browse files
authored
docs(repo): update issue templates
1 parent 5eacf0b commit 6cd2c7e

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@ assignees: ''
77

88
---
99

10-
Please choose the relevant section, follow the instructions and delete the other sections:
10+
<!-- Please choose the relevant section, follow the instructions and delete the other sections:
1111
1212
1. Graphical issue inside a terminal pane (eg. something does not look as it should or as it looks outside of Zellij)
1313
2. Issues with the Zellij UI / behavior
1414
15-
** 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. **
15+
** Please note: comparisons of desired behavior to tmux are usually not relevant. tmux and Zellij are two extremely different programs that do things very differently. Zellij is not, nor does it try to be, a tmux clone. Please try to refrain from such comparisons. **
16+
-->
1617

1718
# 1. Graphical issue inside a terminal pane (eg. something does not look as it should)
1819

@@ -36,8 +37,21 @@ Please attach the files that were created in `/tmp/zellij-1000/zellij-log/` to t
3637
Reproduction steps, noticeable behavior, related issues, etc
3738

3839
# 2. Issues with the Zellij UI / behavior
39-
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.
40+
<!-- Please find a minimal reproduction.
41+
42+
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 you can.
43+
44+
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.
45+
46+
You're the expert on your system and we believe you are in the best position to troubleshoot it. Thank you for understanding.
4047
4148
Example of a good issue report: "The `default_tab_template` layout node does not work when resurrecting sessions".
4249
4350
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".
51+
-->
52+
53+
## Issue description
54+
55+
## Minimal reproduction
56+
57+
## Other relevant information

0 commit comments

Comments
 (0)