From 9643e9c7a666e818bb672d642757f8c20d279fc2 Mon Sep 17 00:00:00 2001 From: taylrfnt Date: Sun, 6 Apr 2025 19:29:58 -0500 Subject: [PATCH 01/12] introduce issue triage template --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 139 +++++++++++++++++++ 1 file changed, 139 insertions(+) create mode 100644 .github/DISCUSSION_TEMPLATE/issue-triage.yml diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml new file mode 100644 index 000000000..42c89c004 --- /dev/null +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -0,0 +1,139 @@ +labels: ["needs confirmation"] +body: + - type: markdown + attributes: + value: | + > [!IMPORTANT] + > Please read through [the Discussion rules](https://github.com/ghostty-org/ghostty/discussions/6937) and review [the FAQs](https://ghostty.org/docs/help#common-issues-and-solutions) prior to opening a new Discussion. + - type: markdown + attributes: + value: "# Issue Details" + - type: textarea + attributes: + label: Issue Description + description: | + Provide a detailed description of the issue. Include relevant information, such as: + - The feature or configuration option you encounter the issue with. + - The expected behavior. + - The actual behavior (and how it deviates from the expected behavior, if it is not immediately obvious). + - Relevant Ghostty logs or other stacktraces. + - Relevant screenshots, screen recordings, or other supporting media (as needed). + - If this is a regression of an existing issue that was closed or resolved, please include the previous item reference (Discussion, Issue, PR) in your description. + + >[!TIP] + > **Not sure what information to include?** + > Here are some recommendations: + > - **Input issues:** include your keyboard layout, a screenshot of the terminal inspector's logged keystrokes (Linux: ctrl+shift+i; MacOS: cmd+alt+i), input method, Linux input method engine (IBus, Fcitx 5, or none) and its version. + > - **Font issues:** include the problematic character(s), the output of `ghostty +show-face` for these character(s), and if they work in other applications. + > - **VT issues (including image rendering issues):** attach an [asciinema](https://docs.asciinema.org/getting-started/) cast file, shell script, or text file for reproduction. + > - **Renderer issues:** (Linux) include your OpenGL version, graphics card, driver version. + + placeholder: | + Example: When using SSH to connect to my remote Linux machine from my local macOS device in Ghostty, I try to run `clear`, and the screen does not clear. Instead, I see the following error message printed to the terminal: `Error opening terminal: xterm-ghostty.` + validations: + required: true + - type: textarea + attributes: + label: Reproduction Steps + description: | + Provide a detailed set of step-by-step instructions for reproducing this issue. + placeholder: | + 1. Open Ghostty. + 2. Connect to a remote server via SSH. + 3. Try to execute `clear`. + 4. Observe `xterm-ghostty` error message above. + validations: + required: true + - type: textarea + attributes: + label: Ghostty Version + description: Paste the output of `ghostty +version` here. + placeholder: | + Ghostty 1.1.3 + + Version + - version: 1.1.3 + - channel: stable + Build Config + - Zig version: 0.13.0 + - build mode : builtin.OptimizeMode.ReleaseFast + - app runtime: apprt.Runtime.none + - font engine: font.main.Backend.coretext + - renderer : renderer.Metal + - libxev : main.Backend.kqueue + render: text + validations: + required: true + - type: input + attributes: + label: OS Version Information + description: | + Please tell us what operating system (name and version) you are using. + placeholder: Ubuntu 24.04.1 (Noble Numbat) + validations: + required: true + - type: dropdown + attributes: + label: (Linux only) Display Server + description: | + If you run Linux, please tell us if you use X11 or Wayland. If you aren't sure, you can determine this by running `[ -z "$WAYLAND_DISPLAY" ] && echo X11 || echo Wayland`. + options: + - X11 + - Wayland + - Other + validations: + required: false + - type: input + attributes: + label: (Linux only) Desktop Environment/Window Manager + description: | + If you run Linux, please tell us what Desktop Environment/Window Manager you are using (include the name and version). + placeholder: GNOME 47.4 + validations: + required: false + - type: textarea + attributes: + label: Ghostty Configuration + description: | + Please paste the output of `ghostty +show-config` here. + placeholder: | + font-family = CommitMono Nerd Font + font-family-bold = CommitMono Nerd Font + font-family-italic = CommitMono Nerd Font + font-family-bold-italic = CommitMono Nerd Font + font-feature = +cv07 + font-size = 16 + font-thicken = true + theme = catppuccin-mocha + render: ini + validations: + required: true + - type: textarea + attributes: + label: Additional Relevant Configuration + description: | + If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide any relevant configuration information here. If you use custom CSS or shaders for Ghostty, please also include them here, if applicable to your issue. + placeholder: | + `tmux.conf` + --- + set -g default-terminal "tmux-256color" + set-option -sa terminal-overrides ",xterm*:Tc" + set -g base-index 1 + setw -g pane-base-index 1 + render: text + validations: + required: false + - type: markdown + attributes: + value: | + # User Acknowledgements + > [!TIP] + > Use the following links to review the existing Ghostty [Discussions](https://github.com/ghostty-org/ghostty/discussions?discussions_q=) and [Issues](https://github.com/ghostty-org/ghostty/issues?q=sort%3Areactions-desc). + - type: checkboxes + attributes: + label: "I acknowledge that:" + options: + - label: I have reviewed the FAQ and confirm that my issue is NOT among them. + required: true + - label: I have searched the Ghostty repository (both open and closed Discussions and Issues) and confirm this is not a duplicate of an exiting issue or discussion. + required: true From c7635d5f418defdb3f01d99b870dc52208763482 Mon Sep 17 00:00:00 2001 From: taylrfnt <43214679+taylrfnt@users.noreply.github.com> Date: Mon, 7 Apr 2025 15:19:38 -0500 Subject: [PATCH 02/12] remove the please Co-authored-by: Kat <65649991+00-kat@users.noreply.github.com> --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index 42c89c004..cb69df07e 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -112,7 +112,7 @@ body: attributes: label: Additional Relevant Configuration description: | - If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide any relevant configuration information here. If you use custom CSS or shaders for Ghostty, please also include them here, if applicable to your issue. + If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide any relevant configuration information here. If you use custom CSS or shaders for Ghostty, also include them here, if applicable to your issue. placeholder: | `tmux.conf` --- From ddb85ca1b1a1183163c63088b1804ad7ad961a64 Mon Sep 17 00:00:00 2001 From: taylrfnt <43214679+taylrfnt@users.noreply.github.com> Date: Mon, 7 Apr 2025 15:25:54 -0500 Subject: [PATCH 03/12] better discussion & issue callout in the important note Co-authored-by: Kat <65649991+00-kat@users.noreply.github.com> --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index cb69df07e..2f5142d09 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -4,7 +4,7 @@ body: attributes: value: | > [!IMPORTANT] - > Please read through [the Discussion rules](https://github.com/ghostty-org/ghostty/discussions/6937) and review [the FAQs](https://ghostty.org/docs/help#common-issues-and-solutions) prior to opening a new Discussion. + > Please read through [the Discussion rules](https://github.com/ghostty-org/ghostty/discussions/6937), review [the FAQs](https://ghostty.org/docs/help#common-issues-and-solutions), and check for both existing [Discussions](https://github.com/ghostty-org/ghostty/discussions?discussions_q=) and [Issues](https://github.com/ghostty-org/ghostty/issues?q=sort%3Areactions-desc) prior to opening a new Discussion. - type: markdown attributes: value: "# Issue Details" From d3b7fe347364184beec6a48ffb39e206ff458ac2 Mon Sep 17 00:00:00 2001 From: taylrfnt Date: Mon, 7 Apr 2025 15:28:31 -0500 Subject: [PATCH 04/12] make following into these for better readability --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index 2f5142d09..8c7d5d507 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -128,7 +128,7 @@ body: value: | # User Acknowledgements > [!TIP] - > Use the following links to review the existing Ghostty [Discussions](https://github.com/ghostty-org/ghostty/discussions?discussions_q=) and [Issues](https://github.com/ghostty-org/ghostty/issues?q=sort%3Areactions-desc). + > Use the these links to review the existing Ghostty [Discussions](https://github.com/ghostty-org/ghostty/discussions?discussions_q=) and [Issues](https://github.com/ghostty-org/ghostty/issues?q=sort%3Areactions-desc). - type: checkboxes attributes: label: "I acknowledge that:" From b3c61d90f3b9a54c1f4e7c5738d54ae95f793c6b Mon Sep 17 00:00:00 2001 From: taylrfnt Date: Mon, 7 Apr 2025 20:37:57 -0500 Subject: [PATCH 05/12] add note about commits --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index 8c7d5d507..cd19b496b 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -18,7 +18,7 @@ body: - The actual behavior (and how it deviates from the expected behavior, if it is not immediately obvious). - Relevant Ghostty logs or other stacktraces. - Relevant screenshots, screen recordings, or other supporting media (as needed). - - If this is a regression of an existing issue that was closed or resolved, please include the previous item reference (Discussion, Issue, PR) in your description. + - If this is a regression of an existing issue that was closed or resolved, please include the previous item reference (Discussion, Issue, PR, commit) in your description. >[!TIP] > **Not sure what information to include?** From 92959bc09c53bafdb8484e0b4491a30512c6f3d3 Mon Sep 17 00:00:00 2001 From: taylrfnt <43214679+taylrfnt@users.noreply.github.com> Date: Mon, 7 Apr 2025 20:39:22 -0500 Subject: [PATCH 06/12] fix typo Co-authored-by: Kat <65649991+00-kat@users.noreply.github.com> --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index cd19b496b..e9f8c587d 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -128,7 +128,7 @@ body: value: | # User Acknowledgements > [!TIP] - > Use the these links to review the existing Ghostty [Discussions](https://github.com/ghostty-org/ghostty/discussions?discussions_q=) and [Issues](https://github.com/ghostty-org/ghostty/issues?q=sort%3Areactions-desc). + > Use these links to review the existing Ghostty [Discussions](https://github.com/ghostty-org/ghostty/discussions?discussions_q=) and [Issues](https://github.com/ghostty-org/ghostty/issues?q=sort%3Areactions-desc). - type: checkboxes attributes: label: "I acknowledge that:" From a6123c044735cefeacfa6da94b1ebe4670a6a2f1 Mon Sep 17 00:00:00 2001 From: taylrfnt Date: Mon, 7 Apr 2025 20:41:04 -0500 Subject: [PATCH 07/12] fix trailing whitespace --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index e9f8c587d..faac466db 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -18,7 +18,7 @@ body: - The actual behavior (and how it deviates from the expected behavior, if it is not immediately obvious). - Relevant Ghostty logs or other stacktraces. - Relevant screenshots, screen recordings, or other supporting media (as needed). - - If this is a regression of an existing issue that was closed or resolved, please include the previous item reference (Discussion, Issue, PR, commit) in your description. + - If this is a regression of an existing issue that was closed or resolved, please include the previous item reference (Discussion, Issue, PR, commit) in your description. >[!TIP] > **Not sure what information to include?** From 9440dbba1a48fc606a9b08f86e4dc84e6eec12ef Mon Sep 17 00:00:00 2001 From: taylrfnt Date: Mon, 7 Apr 2025 21:25:26 -0500 Subject: [PATCH 08/12] add notes abotu minimum config --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index faac466db..f33f83fb9 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -95,7 +95,7 @@ body: attributes: label: Ghostty Configuration description: | - Please paste the output of `ghostty +show-config` here. + Please provide the minimum conifguration needed to reproduce this issue. If you cannot determine the minimum configuration needed to reproduce the issue, paste the output of `ghostty +show-config` here. placeholder: | font-family = CommitMono Nerd Font font-family-bold = CommitMono Nerd Font @@ -112,7 +112,7 @@ body: attributes: label: Additional Relevant Configuration description: | - If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide any relevant configuration information here. If you use custom CSS or shaders for Ghostty, also include them here, if applicable to your issue. + If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide any relevant configuration information here. Please provide the minimal configuration needed. If you use custom CSS or shaders for Ghostty, also include them here, if applicable to your issue. placeholder: | `tmux.conf` --- From 279a6b6f58ff2e7b42136f99165edb85335ec9c3 Mon Sep 17 00:00:00 2001 From: taylrfnt Date: Mon, 7 Apr 2025 21:27:01 -0500 Subject: [PATCH 09/12] fix typos & make it read more naturally --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index f33f83fb9..3ed106ce8 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -95,7 +95,7 @@ body: attributes: label: Ghostty Configuration description: | - Please provide the minimum conifguration needed to reproduce this issue. If you cannot determine the minimum configuration needed to reproduce the issue, paste the output of `ghostty +show-config` here. + Please provide the minimum configuration needed to reproduce this issue. If you cannot determine the minimum configuration needed to reproduce the issue, paste the output of `ghostty +show-config` here. placeholder: | font-family = CommitMono Nerd Font font-family-bold = CommitMono Nerd Font @@ -112,7 +112,7 @@ body: attributes: label: Additional Relevant Configuration description: | - If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide any relevant configuration information here. Please provide the minimal configuration needed. If you use custom CSS or shaders for Ghostty, also include them here, if applicable to your issue. + If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide a minimum version of the relevant configuration information here. If you use custom CSS or shaders for Ghostty, also include them here, if applicable to your issue. placeholder: | `tmux.conf` --- From 8a446b77761dbad529ceb9fc64971d808eacb21c Mon Sep 17 00:00:00 2001 From: taylrfnt <43214679+taylrfnt@users.noreply.github.com> Date: Mon, 7 Apr 2025 21:41:09 -0500 Subject: [PATCH 10/12] remove the verbosity Co-authored-by: Kat <65649991+00-kat@users.noreply.github.com> --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index 3ed106ce8..09137f3d1 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -95,7 +95,7 @@ body: attributes: label: Ghostty Configuration description: | - Please provide the minimum configuration needed to reproduce this issue. If you cannot determine the minimum configuration needed to reproduce the issue, paste the output of `ghostty +show-config` here. + Please provide the minimum configuration needed to reproduce this issue. If you cannot determine this, paste the output of `ghostty +show-config` here. placeholder: | font-family = CommitMono Nerd Font font-family-bold = CommitMono Nerd Font From 6d36eeef3c6477bbb92b7a251b81873cf0ca935e Mon Sep 17 00:00:00 2001 From: taylrfnt <43214679+taylrfnt@users.noreply.github.com> Date: Mon, 7 Apr 2025 21:41:29 -0500 Subject: [PATCH 11/12] add the verbosity Co-authored-by: Kat <65649991+00-kat@users.noreply.github.com> --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index 09137f3d1..d3cf58537 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -112,7 +112,7 @@ body: attributes: label: Additional Relevant Configuration description: | - If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide a minimum version of the relevant configuration information here. If you use custom CSS or shaders for Ghostty, also include them here, if applicable to your issue. + If your issue involves other programs, tools, or applications in addition to Ghostty (e.g. Neovim, tmux, Zellij, etc.), please provide the minimum configuration needed for all relevant programs to reproduce the issue here. If you use custom CSS or shaders for Ghostty, also include them here, if applicable to your issue. placeholder: | `tmux.conf` --- From 49a97a589c51c367258bba4810ee49bdbc587de8 Mon Sep 17 00:00:00 2001 From: taylrfnt <43214679+taylrfnt@users.noreply.github.com> Date: Thu, 10 Apr 2025 17:45:35 -0500 Subject: [PATCH 12/12] fix typo - exiting to existing Co-authored-by: Leah Amelia Chen --- .github/DISCUSSION_TEMPLATE/issue-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/DISCUSSION_TEMPLATE/issue-triage.yml b/.github/DISCUSSION_TEMPLATE/issue-triage.yml index d3cf58537..35ed2dc33 100644 --- a/.github/DISCUSSION_TEMPLATE/issue-triage.yml +++ b/.github/DISCUSSION_TEMPLATE/issue-triage.yml @@ -135,5 +135,5 @@ body: options: - label: I have reviewed the FAQ and confirm that my issue is NOT among them. required: true - - label: I have searched the Ghostty repository (both open and closed Discussions and Issues) and confirm this is not a duplicate of an exiting issue or discussion. + - label: I have searched the Ghostty repository (both open and closed Discussions and Issues) and confirm this is not a duplicate of an existing issue or discussion. required: true