diff options
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 25 | ||||
| -rw-r--r-- | .github/pull_request_template.md | 6 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 34 |
3 files changed, 29 insertions, 36 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. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f677e938..0075f322 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,40 +23,6 @@ Bug reports should be reported in the [Alacritty issue tracker](https://github.c If a bug was not present in a previous version of Alacritty, providing the exact commit which introduced the regression helps out a lot. -Since a multitude of operating systems are supported by Alacritty, not all issues might apply to every OS. So make sure to specify on which OS the bug has been found. Since Linux has a variety of window managers, compositors and display servers, please also specify those when encountering an issue on Linux. - -Depending on the bug, it might also be useful to provide some of the following information: - - Configuration file - - `alacritty -v(vv)` output - - `alacritty --print-events` output - - `glxinfo` output - - `xrandr` output - -Here's a template that you can use to file a bug, though it's not necessary to use it exactly: - -``` -# System -| | | -|------------------|-------------------------------| -| Operating System | [Linux/BSD/macOS/Windows] | -| Rust Version | [stable/beta/nightly/X.Y.Z] | -| Display Server | [X11/Wayland] (only on Linux) | -| Window Manager | [i3/xfwm/...] (only on Linux) | -| Compositor | [compton/...] (only on Linux) | - -# Summary -[Short summary of the Bug] - -# Behavior -[Description of Alacritty's current behavior] - -# Expectation -[Description of expected behavior] - -# Extra -[Additional information like config or logs] -``` - ## Patches / Pull Requests All patches have to be sent on Github as [pull requests](https://github.com/jwilm/alacritty/pulls). |