Skip to content

Commit

Permalink
docs(perf-benchmarks): say how long things take (#5167)
Browse files Browse the repository at this point in the history
  • Loading branch information
wjhsf authored Jan 30, 2025
1 parent 1c546b1 commit 1193957
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions packages/@lwc/perf-benchmarks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ cd packages/@lwc/perf-benchmarks
../../../node_modules/.bin/tach --config dist/__benchmarks__/path/to/tachometer.json
```

> [!TIP]
> Running all of the benchmarks will take multiple hours. Let it run overnight!
## Manual testing

When the benchmark is not working, the best way to debug it locally is to load its HTML file and inspect it in the Chrome DevTools. After building, you can run:
Expand Down Expand Up @@ -84,3 +87,6 @@ This package also supports [Best](https://bestjs.dev) as a benchmark runner. To
Or for CI:

yarn test:performance:best:ci

> [!TIP]
> Best tests only take a few dozen minutes. Take a break!

0 comments on commit 1193957

Please sign in to comment.