-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnot now
Description
📚 Documentation
The benchmark.md should be the go-to reference document on how to load test and measure the engine's performance,
but currently it's outdated, we should update it with the following guidelines:
- First of all, ALWAYS register the specs and OS of the machines you’re using.
- Write down every relevant command/function that you use, be it the shell or the codebase of the game.
- Also, always write down each parameter combination you’re using.
- Use multiple sources for load testing and benchmarks, like htop, etop, fprop, NewRelic.
- Pictures/ Logs > Videos, maybe use videos when performance affects UX.
- Log your results on a folder on the repo, this is important since we want to track advancements and regressions.
- Of course, update the API of the functions accordingly.
- This kind of benchmark is experimental, but we should always do the same
to have a valid way to compare if we’ve advanced or regressed.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationnot now