diff options
| author | Christian Duerr <contact@christianduerr.com> | 2020-01-02 19:19:32 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-02 19:19:32 +0000 |
| commit | d774c7f3a3466b6d7dbcce4c149d74c041036c9f (patch) | |
| tree | 2c13939e47a9183a5b1dcfb0f6ec45e5c199a6ab | |
| parent | f632919134414e31ffd3ae9b5732d673deb0adf5 (diff) | |
| download | alacritty-d774c7f3a3466b6d7dbcce4c149d74c041036c9f.tar.gz alacritty-d774c7f3a3466b6d7dbcce4c149d74c041036c9f.zip | |
Improve performance benchmarking documentation
Fixes #3136.
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93217ded..d94d2f87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,9 +67,16 @@ complete correctly with the unpatched version, to make sure the test case is cov ### Performance +If changes could affect throughput or latency of Alacritty, these aspects should be benchmarked to +prevent potential regressions. Since there are often big performance differences between Rust's +nightly releases, it's advised to perform these tests on the latest Rust stable release. + Alacritty mainly uses the [vtebench](https://github.com/jwilm/vtebench) tool for testing Alacritty's -performance. Any change which could have an impact on Alacritty's performance, should be tested with -it to prevent potential regressions. +performance. Instructions on how to use it can be found in its +[README](https://github.com/jwilm/vtebench/blob/master/README.md). + +Latency is another important factor for Alacritty. On X11, Windows, and macOS the +[typometer](https://github.com/pavelfatin/typometer) tool allows measuring keyboard latency. ### Documentation |