Skip to content

Commit 6663619

Browse files
authored
Introduce Issue Triage Template (#7012)
The helper team has been discussing some common issues we see with Discussion submissions (missing info, duplicates, etc.), and pluie's #6937 has been a huge step forward - this PR introduces a template for the Issue Triage Discussion type. The template has gone through a few revisions prior to this PR, but I am certain there are probably a few places to be cleaned up. You can test it out by [opening a new "Issue Triage" Discussion in my fork](https://github.com/taylrfnt/ghostty/discussions/new?category=issue-triage). ~~Creating this as a draft for now, since I may not be able to respond to any review comments in a timely manner.~~
2 parents f777138 + 49a97a5 commit 6663619

File tree

1 file changed

+139
-0
lines changed

1 file changed

+139
-0
lines changed
Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
labels: ["needs confirmation"]
2+
body:
3+
- type: markdown
4+
attributes:
5+
value: |
6+
> [!IMPORTANT]
7+
> 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.
8+
- type: markdown
9+
attributes:
10+
value: "# Issue Details"
11+
- type: textarea
12+
attributes:
13+
label: Issue Description
14+
description: |
15+
Provide a detailed description of the issue. Include relevant information, such as:
16+
- The feature or configuration option you encounter the issue with.
17+
- The expected behavior.
18+
- The actual behavior (and how it deviates from the expected behavior, if it is not immediately obvious).
19+
- Relevant Ghostty logs or other stacktraces.
20+
- Relevant screenshots, screen recordings, or other supporting media (as needed).
21+
- 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.
22+
23+
>[!TIP]
24+
> **Not sure what information to include?**
25+
> Here are some recommendations:
26+
> - **Input issues:** include your keyboard layout, a screenshot of the terminal inspector's logged keystrokes (Linux: <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>i</kbd>; MacOS: <kbd>cmd</kbd>+<kbd>alt</kbd>+<kbd>i</kbd>), input method, Linux input method engine (IBus, Fcitx 5, or none) and its version.
27+
> - **Font issues:** include the problematic character(s), the output of `ghostty +show-face` for these character(s), and if they work in other applications.
28+
> - **VT issues (including image rendering issues):** attach an [asciinema](https://docs.asciinema.org/getting-started/) cast file, shell script, or text file for reproduction.
29+
> - **Renderer issues:** (Linux) include your OpenGL version, graphics card, driver version.
30+
31+
placeholder: |
32+
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.`
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Reproduction Steps
38+
description: |
39+
Provide a detailed set of step-by-step instructions for reproducing this issue.
40+
placeholder: |
41+
1. Open Ghostty.
42+
2. Connect to a remote server via SSH.
43+
3. Try to execute `clear`.
44+
4. Observe `xterm-ghostty` error message above.
45+
validations:
46+
required: true
47+
- type: textarea
48+
attributes:
49+
label: Ghostty Version
50+
description: Paste the output of `ghostty +version` here.
51+
placeholder: |
52+
Ghostty 1.1.3
53+
54+
Version
55+
- version: 1.1.3
56+
- channel: stable
57+
Build Config
58+
- Zig version: 0.13.0
59+
- build mode : builtin.OptimizeMode.ReleaseFast
60+
- app runtime: apprt.Runtime.none
61+
- font engine: font.main.Backend.coretext
62+
- renderer : renderer.Metal
63+
- libxev : main.Backend.kqueue
64+
render: text
65+
validations:
66+
required: true
67+
- type: input
68+
attributes:
69+
label: OS Version Information
70+
description: |
71+
Please tell us what operating system (name and version) you are using.
72+
placeholder: Ubuntu 24.04.1 (Noble Numbat)
73+
validations:
74+
required: true
75+
- type: dropdown
76+
attributes:
77+
label: (Linux only) Display Server
78+
description: |
79+
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`.
80+
options:
81+
- X11
82+
- Wayland
83+
- Other
84+
validations:
85+
required: false
86+
- type: input
87+
attributes:
88+
label: (Linux only) Desktop Environment/Window Manager
89+
description: |
90+
If you run Linux, please tell us what Desktop Environment/Window Manager you are using (include the name and version).
91+
placeholder: GNOME 47.4
92+
validations:
93+
required: false
94+
- type: textarea
95+
attributes:
96+
label: Ghostty Configuration
97+
description: |
98+
Please provide the minimum configuration needed to reproduce this issue. If you cannot determine this, paste the output of `ghostty +show-config` here.
99+
placeholder: |
100+
font-family = CommitMono Nerd Font
101+
font-family-bold = CommitMono Nerd Font
102+
font-family-italic = CommitMono Nerd Font
103+
font-family-bold-italic = CommitMono Nerd Font
104+
font-feature = +cv07
105+
font-size = 16
106+
font-thicken = true
107+
theme = catppuccin-mocha
108+
render: ini
109+
validations:
110+
required: true
111+
- type: textarea
112+
attributes:
113+
label: Additional Relevant Configuration
114+
description: |
115+
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.
116+
placeholder: |
117+
`tmux.conf`
118+
---
119+
set -g default-terminal "tmux-256color"
120+
set-option -sa terminal-overrides ",xterm*:Tc"
121+
set -g base-index 1
122+
setw -g pane-base-index 1
123+
render: text
124+
validations:
125+
required: false
126+
- type: markdown
127+
attributes:
128+
value: |
129+
# User Acknowledgements
130+
> [!TIP]
131+
> 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).
132+
- type: checkboxes
133+
attributes:
134+
label: "I acknowledge that:"
135+
options:
136+
- label: I have reviewed the FAQ and confirm that my issue is NOT among them.
137+
required: true
138+
- 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.
139+
required: true

0 commit comments

Comments
 (0)