pogmommy/zellij
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(repo): update issue templates

Browse source
This commit is contained in:
Aram Drevekenin 2023-12-06 19:58:34 +01:00 • committed by GitHub
parent 6370a897ed
commit 5eacf0bb50
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.github/ISSUE_TEMPLATE/blank_issue.md vendored
View file

@ -1,4 +1,10 @@
--- ---
name: Blank Issue name: Blank Issue
about: Create a blank issue. about: Create a blank issue.
title: ''
labels: ''
assignees: ''
--- ---

32
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -1,11 +1,20 @@
--- ---
name: "\U0001F41B Bug Report" name: "\U0001F41B Bug Report"
about: "If something isn't working as expected." about: If something isn't working as expected.
title: ''
labels: bug 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) 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` 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** **Basic information**
`zellij --version`: `zellij --version`:
`stty size`: `stty size`:
`uname -av` or `ver`(Windows): `uname -av` or `ver`(Windows):
List of programs you interact with as, `PROGRAM --version`: output cropped meaningful, for example: ## Further information
`nvim --version`: NVIM v0.5.0-dev+1299-g1c2e504d5 (used the appimage release)
`alacritty --version`: alacritty 0.7.2 (5ac8060b)
**Further information**
Reproduction steps, noticeable behavior, related issues, etc 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".