Skip to content

Commit 2d25957

Browse files
authored
contributing: Add docs for how to add a benchmark to the PR bench runner (#1633)
1 parent 0fab977 commit 2d25957

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,8 @@ The maintainers of this repository assign milestones to pull requests to classif
6161

6262
### Benchmarks
6363

64-
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`.
64+
Some benchmarks will run on any new PR commits, the results will be commented into the PR on completion.
65+
66+
#### Adding a new benchmark
67+
To add additional benchmarks that should run for every PR go to `.gitlab/scripts/run-benchmarks.sh`.
68+
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.

0 commit comments

Comments
 (0)