diff --git a/docs/running_benchmarks.rst b/docs/running_benchmarks.rst index 6914dd1..413464b 100644 --- a/docs/running_benchmarks.rst +++ b/docs/running_benchmarks.rst @@ -63,6 +63,10 @@ To contribute your results back to the project, please use the following workflo Then, open a PR to merge the results to the `main` branch. +.. note:: + + When running tests with `sudo` the new results may be owned by `root`. To avoid having to run pre-commit hooks in sudo you may need to change the owner of the results first, e.g., via ``sudo chown -R results + .. note:: Each result file should be single to double-digit KB in size; if we ever reach the point where this is prohibitive to store on GitHub itself, then we will investigate other upload strategies and purge the folder from the repository history.