mslot
/
alacritty
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Christian Duerr 2019-12-01 03:15:21 +01:00 committed by GitHub
parent 400d24f023
commit 918ce9dead
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
.github/ISSUE_TEMPLATE.md vendored
View File

@ -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 |

6
.github/pull_request_template.md vendored Normal file
View File

@ -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.

34
CONTRIBUTING.md
View File

@ -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).