charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 02:50:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Paul Pacheco 2020-10-13 20:24:33 -05:00 committed by GitHub
parent a3d532fea0
commit ad30db3cd7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -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. 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 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. 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 will make a difference for actual games using Mirror.
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. 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.