Infrastructure: Benchmarks #5
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
help wanted
Extra attention is needed
After a successful build on Github Actions, it is recommended to run Benchmarks and post the results as a comment on the commit. This can help others conveniently determine if their new code negatively affects performance, as comments on commits are sent to Discord via webhook. For benchmark testing, it is recommended to use BenchmarkDotNet, which supports the
dotnet test
command. Our choice for choosing BenchmarkDotNet should be fairly obvious, however you should checkout their Readme if you're having difficulty understanding why. To organize the code, it is suggested to create a separatebenchmarks
folder for benchmark tests, and atests
folder for functional tests. Functional testing is not in the scope of this issue and will instead of tackled on a seperate issue or PR.BenchmarkDotNet should measure the following:
The benchmarking should be performed only against Linux, as it is the core "OS" for which the bot is designed. While Windows and Mac support will be offered on a best-effort basis, intentional support for those platforms will not be provided.
The text was updated successfully, but these errors were encountered: