diff options
| author | Christian Duerr <chrisduerr@users.noreply.github.com> | 2019-01-17 09:17:26 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-01-17 09:17:26 +0000 |
| commit | 0d16478f5d997b6da5488885e15bfb09ca8e7f6d (patch) | |
| tree | 9905e264149d5955ce1161ecf41ad2f23ec9ec91 /CONTRIBUTING.md | |
| parent | 5864c30a54b250163c3a94f053f5f1b907adf9c9 (diff) | |
| download | alacritty-0d16478f5d997b6da5488885e15bfb09ca8e7f6d.tar.gz alacritty-0d16478f5d997b6da5488885e15bfb09ca8e7f6d.zip | |
Make all configuration fields optional
All configuration fields now have fallback values which will be used if
the field is not present. This includes mouse, key bindings and platform
specific differences.
The mouse and key bindings are now filled by default, if the user
rebinds a default mapping, it will be overwritten. To unbind a default
binding, it can be mapped to `chars: ""`.
Since all platform differences can now be correctly handled by the
`src/config/mod.rs` code, it's no longer necessary to maintain separate
configuration files, so the `alacritty_macos.yml` and
`alacritty_windows.yml` have been deleted.
Fixes #40.
Fixes #1923.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c24df1b8..a38c5a02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,7 +83,7 @@ Alacritty mainly uses the [vtebench](https://github.com/jwilm/vtebench) tool for Code should be documented where appropriate. The existing code can be used as a guidance here and the general `rustfmt` rules can be followed for formatting. -If any change has been made to the `config.rs` file, these changes should be documented in the example configuration files `alacritty.yml`, `alacritty_macos.yml` and `alacritty_windows.yml`. Only changes which are exclusive to a specific platform do not need to be added to all configuration files. +If any change has been made to the `config.rs` file, these changes should also be documented in the example configuration file `alacritty.yml`. Changes compared to the latest Alacritty release which have a direct effect on the user (opposed to things like code refactorings or documentation/tests) additionally need to be documented in the `CHANGELOG.md`. The existing entries should be used as a style guideline. The change log should be used to document changes from a user-perspective, instead of explaining the technical background (like commit messages). More information about Alacritty's change log format can be found [here](https://keepachangelog.com). |