From bfb903815c1eda50b3598c8403e881b46c6db6c2 Mon Sep 17 00:00:00 2001 From: Philipp Hofmann Date: Thu, 23 Jan 2025 11:37:39 +0100 Subject: [PATCH] feat(dev-docs): Add LOGAF scale to code review Add the LOGAF scale to the code review docs, as multiple SDK develop docs mention the LOGAF scale. Instead of having it duplicated, we have one central place explaining it. --- develop-docs/engineering-practices/code-review.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/develop-docs/engineering-practices/code-review.mdx b/develop-docs/engineering-practices/code-review.mdx index 1d227405f56245..54719abffb6c47 100644 --- a/develop-docs/engineering-practices/code-review.mdx +++ b/develop-docs/engineering-practices/code-review.mdx @@ -216,3 +216,11 @@ Please be pragmatic, and consider the cost of each incremental request for chang - Feedback is objective and actionable - Submitter responds to feedback and makes changes promptly - PR is approved and merged within 48 hours + +### LOGAF Scale + +For feedback in PRs, you can use the [LOGAF scale](https://blog.danlew.net/2020/04/15/the-logaf-scale/) to specify how important a comment is: + +- `l`: low - nitpick. You may address this comment, but you don't have to. +- `m`: medium - normal comment. Worth addressing and fixing. +- `h`: high - Very important. We must not merge this PR without addressing this issue.