From be020c588c89e6f223d9b57366f0a7d0e04fb7b9 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Tue, 11 Jan 2022 14:32:37 +0100 Subject: [PATCH] Clarify the case when a new benchmark project should be added ^KT-49921 Fixed --- libraries/tools/gradle/regression-benchmarks/Readme.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/libraries/tools/gradle/regression-benchmarks/Readme.md b/libraries/tools/gradle/regression-benchmarks/Readme.md index d84502d6c4f..6ba4c6bea5d 100644 --- a/libraries/tools/gradle/regression-benchmarks/Readme.md +++ b/libraries/tools/gradle/regression-benchmarks/Readme.md @@ -1,6 +1,6 @@ ## Description -Contains build regression benchmark scripts for different user projects. +Contains build regression benchmark scripts for different Kotlin projects. Such benchmarks comparing different build scenarios between last stable Kotlin release and current-in-progress release helping to identify build speed regressions with minimal user-project modifications. @@ -9,6 +9,9 @@ All scripts should run via related Gradle task which could be found in "Gradle R ### Adding benchmark for new user-project +_**Before adding a new project, consider checking existing one** - they possibly may cover the case you want to check. New project +should provide unique build setup/codebase that is not covered by existing projects._ + All scripts are using infrastructure provided by [template](../regression-benchmark-templates/Readme.md). - Add new script file in `benchmarkScripts/` directory