Skip to content

Commit

Permalink
Add note about submitting results to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oruebel committed Apr 24, 2024
1 parent 22c92ef commit 6e14413
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/running_benchmarks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <new_owner> 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.

0 comments on commit 6e14413

Please sign in to comment.