From 2d259577c708a035e4ca6346230c55192a16e4b1 Mon Sep 17 00:00:00 2001 From: Andrew Glaude Date: Wed, 21 Dec 2022 09:51:10 -0500 Subject: [PATCH] contributing: Add docs for how to add a benchmark to the PR bench runner (#1633) --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b84bfb8ca6..56571a7072 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -61,4 +61,8 @@ The maintainers of this repository assign milestones to pull requests to classif ### Benchmarks -Some benchmarks will run on any new PR commits, the results will be commented into the PR on completion. To see the list of benchmarks or to add additional benchmarks run go to `.gitlab/scripts/run-benchmarks.sh`. \ No newline at end of file +Some benchmarks will run on any new PR commits, the results will be commented into the PR on completion. + +#### Adding a new benchmark +To add additional benchmarks that should run for every PR go to `.gitlab/scripts/run-benchmarks.sh`. +Add the name of your benchmark to the list in `-bench "BenchmarkConcurrentTracing|BenchmarkStartSpan"` using pipe character separators. Note that your new benchmark must already exist in the `main` branch, for that reason it is best for new benchmarks to be added in their own PR and a second PR opened afterwards to add them to the PR benchmark script. \ No newline at end of file