Skip to content

Commit 0ecc190

Browse files
committed
add docs documentation
1 parent c9ab694 commit 0ecc190

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/contributing.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,4 +230,11 @@ If an existing Zarr format version changes, or a new version of the Zarr format
230230
## Release procedure
231231

232232
Open an issue on GitHub announcing the release using the release checklist template:
233-
[https://github.com/zarr-developers/zarr-python/issues/new?template=release-checklist.md](https://github.com/zarr-developers/zarr-python/issues/new?template=release-checklist.md>). The release checklist includes all steps necessary for the release.
233+
[https://github.com/zarr-developers/zarr-python/issues/new?template=release-checklist.md](https://github.com/zarr-developers/zarr-python/issues/new?template=release-checklist.md>). The release checklist includes all steps necessary for the release.
234+
235+
## Benchmarks
236+
237+
Zarr uses [pytest-benchmark](https://pytest-benchmark.readthedocs.io/en/latest/) for running
238+
performance benchmarks as part of our test suite. The benchmarks can be are found in `tests/benchmarks`.
239+
By default pytest is configured to run these benchmarks as plain tests (i.e., no benchmarking). To run
240+
a benchmark with timing measurements, use the `--benchmark-enable` when invoking `pytest`.

0 commit comments

Comments
 (0)