From a3d532fea0e457eed5214f1e3f04c675d78b52e6 Mon Sep 17 00:00:00 2001 From: Paul Pacheco Date: Tue, 13 Oct 2020 20:23:18 -0500 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1f1434de4..a20e33aa3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -124,7 +124,7 @@ Macro-optimizations tend to change the **scalability** of mirror, by changing a Micro-optimizations tend to change the performance of mirror in a linear way. There are some micro optimizations that make a huge impact on performance such as eliminating allocations in the hot path. -We prefer readable code over optimal code. We do not like any kind of optimization if it makes the code less readable (they generally do). For that reason, we require that both micro and macro optimization pull requests come with screenshots profiling a real game or at least a synthetic **representative** test. It is not enough to show that one operation is faster than the other, you must prove that this makes a significant difference in a realistic Mirror workload. +We prefer readable code over optimal code. We do not like any kind of optimization if it makes the code less readable (they generally do). For that reason, we require that both micro and macro optimization pull requests come with screenshots profiling a real game or at least a benchmark with a realistic Mirror workload. It is not enough to show that one operation is faster than the other, you must prove that this makes a significant difference in a realistic Mirror workload. If your optimization pull request does not come with profiling data showing real gains in a meaningful test is has no hope of getting merged.