Skip to content

Commit

Permalink
contributing: Add docs for how to add a benchmark to the PR bench run…
Browse files Browse the repository at this point in the history
…ner (#1633)
  • Loading branch information
ajgajg1134 authored Dec 21, 2022
1 parent 0fab977 commit 2d25957
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
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.

0 comments on commit 2d25957

Please sign in to comment.