Skip to content

Commit 4de55a4

Browse files
committed
docs: adds contributing guidelines for the benchmarks
Signed-off-by: Vincent Biret <vibiret@microsoft.com>
1 parent bc05994 commit 4de55a4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,3 +105,20 @@ git checkout *.cs
105105
```pwsh
106106
. ./scripts/promoteUnshipped.ps1
107107
```
108+
109+
## Updating the benchmark information
110+
111+
To ensure performance of the library does not degrade over time, we have continuous benchmarks running. You might see the continuous integration failing if your pull request changed any model under __src/Microsoft.OpenApi/Models__.
112+
113+
```txt
114+
Benchmark result for EmptyApiSchema does not match the existing benchmark result (original!=new). Allocated bytes differ: 408 != 416
115+
```
116+
117+
To update the benchmarks, run the following script:
118+
119+
```shell
120+
cd performance/benchmark
121+
dotnet run -c Release
122+
```
123+
124+
Then commit the report files using a "chore" commit.

0 commit comments

Comments
 (0)