Skip to content

docs: add instructions for running performance benchmarks - #266

Open
dosubot[bot] wants to merge 1 commit into
mainfrom
dosu/doc-update-265
Open

docs: add instructions for running performance benchmarks#266
dosubot[bot] wants to merge 1 commit into
mainfrom
dosu/doc-update-265

Conversation

@dosubot

@dosubot dosubot Bot commented Aug 27, 2026

Copy link
Copy Markdown

Update documentation for #265

Updates the CONTRIBUTING guide with a new Benchmarks section. It explains that benchmarks in benchmarks/ are disabled by default via pytest’s --benchmark-disable, and provides the command to run them with pytest --benchmark-enable -n 0 benchmarks/. The note clarifies that -n 0 disables pytest-xdist parallelism to keep benchmark measurements accurate, and mentions the suite includes engine performance tests.

Generated by Dosu

@dosubot
dosubot Bot requested a review from laipz8200 August 27, 2026 09:40
@dosubot dosubot Bot added size:S This PR changes 10-29 lines, ignoring generated files. documentation Improvements or additions to documentation labels Aug 27, 2026
@github-actions

Copy link
Copy Markdown

Thanks for the contribution. Before we can review or merge this pull request, please read our CLA and add this exact comment once: I have read the CLA Document and I hereby sign the CLA


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants