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 /CONTRIBUTING.md | |
| 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 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 34 |
1 files changed, 0 insertions, 34 deletions
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). |