When writing a rule that has to do with performance, you might need to showcase some benchmarks as proof of potential improvements. This should be included in a separate section called `Benchmarks`, under `Resources`.
The format of the benchmarks section is as follows:
* Benchmark table
* Benchmarking code
* Hardware configuration
== Benchmark table
- Do not use abbreviations for statistical terms, not everyone is familiar with them.
- In the `Benchmarks` section, add a subsection called `Glossary` right after the benchmark table and add links to Wikipedia to explain statistical terms used in the header of each column:
The code that was used to generate the benchmarks should be included to provide transparency and allow others to reproduce and verify the results. Preferably, the code snippet should include the sample size, the number of iterations, and the framework/library used to run the benchmarks.
If the code is not showcasing how the results were generated, consider prefixing it with an explanation that links to the framework/library used, for example:
----
The results were generated by running the following snippet with https://github.com/dotnet/BenchmarkDotNet[BenchmarkDotNet].
----
== Hardware configuration
The hardware configuration used to run the benchmarks should be included, for example:
