From 8d9ef2c7db4d8135c4f3e65dde951f72c2cdf97a Mon Sep 17 00:00:00 2001 From: Christian Duerr Date: Mon, 2 Dec 2019 17:12:29 +0100 Subject: [PATCH] Fix PR and issue template --- .github/ISSUE_TEMPLATE.md | 31 ++++++++++--------------------- .github/pull_request_template.md | 5 +---- 2 files changed, 11 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 0e0894fc..5fffe15c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,25 +1,14 @@ -For bug reports, the following information can help speed up the process. +For bug reports, the following information can help speed up the process. Please describe the bug that you have found and what you would expect to happen instead. -Please describe the bug that you have found and what you would expect to happen instead. +### System -# System +OS: Linux/BSD/macOS/Windows +Version: `alacritty --version` output +Linux/BSD: X11/Wayland, DE or Compositor and WM +Windows: WinPTY/ConPTY (see `alacritty -v` output) -| | | -|-------------------|-----------------------------------| -| Operating System | [Linux/BSD/macOS/Windows] | -| Alacritty Version | [`alacritty --version` output] | -| Display Server | [X11/Wayland] (only on Linux) | -| Window Manager | [i3/xfwm/...] (only on Linux) | -| Compositor | [compton/...] (only on Linux) | -| PTY Backend | [WinPTY/ConPTY] (only on Windows) | - -# Logs - -Based on the issue at hand, some logs might be relevant: - -| Command | Issues | -|----------------------------|-----------------------------------------------------| -| STDOUT, STDERR | Crashes | -| `alacritty -vv` | DPI, font size, resize, terminal grid and cell size | -| `alacritty --print-events` | Problems with keyboard and keybindings | +### Logs +Crashes: STDERR, STDOUT +Font/Terminal size: `alacritty -vv` +Keyboard and bindings: `alacritty --print-events` diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8b058a3a..edc3b048 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,6 +1,3 @@ Please make sure to document all user-facing changes in the `CANGELOG.md` file. -Please ensure the optional CI steps do not fail because of this PR. - -Draft PRs are always welcome, though unless otherwise requested PRs will not be reviewed until CI is -successful and they have left the draft stage. +Draft PRs are always welcome, though unless otherwise requested PRs will not be reviewed until all required and optional CI steps are successful and they have left the draft stage.