PolytreeDE/alacritty
1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-18 13:55:23 -05:00
Code Releases Activity

Improve performance benchmarking documentation

Browse source 
Fixes #3136.
This commit is contained in:
Christian Duerr 2020-01-02 19:19:32 +00:00 committed by GitHub
parent f632919134
commit d774c7f3a3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

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