diff options
| author | Christian Duerr <contact@christianduerr.com> | 2019-12-01 03:15:21 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-01 03:15:21 +0100 |
| commit | 918ce9dead33cdb3ee4bbd016cd177313981151c (patch) | |
| tree | dbb943c0d1c545683519267e41ad08b53d239eea /.github | |
| parent | 400d24f02320d648f8b9c51a385c84e05d77b134 (diff) | |
Add new issue and PR templates
This adds a PR template that should remind users to document their
changes in our CHANGELOG, without requiring too much direct interaction
from the user.
The issue template has also been reworked a bit, hopefully making it
easier for people to report bugs, without intruding on them if the
information is irrelevant or providing it is too much effort.
Fixes #3031.
Diffstat (limited to '.github')
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 25 | ||||
| -rw-r--r-- | .github/pull_request_template.md | 6 |
2 files changed, 29 insertions, 2 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 824ddee4..0e0894fc 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,25 @@ -Which operating system does the issue occur on? +For bug reports, the following information can help speed up the process. -If on linux, are you using X11 or Wayland? +Please describe the bug that you have found and what you would expect to happen instead. + +# System + +| | | +|-------------------|-----------------------------------| +| 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 | diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..8b058a3a --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,6 @@ +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. |