From a73f1421afeba523a992457861c676bc70935afe Mon Sep 17 00:00:00 2001 From: Tim Golen Date: Tue, 19 Nov 2024 09:25:55 -0700 Subject: [PATCH] Be even more clear --- tests/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/tests/README.md b/tests/README.md index 87aa9068013b..08df0b89794b 100644 --- a/tests/README.md +++ b/tests/README.md @@ -68,8 +68,9 @@ In order to give future engineers the best context for a unit test, follow this - "When" - Describes what action is being done and the thing that is being tested - "Then" - Describes what is expected to happen -2. DO explain **WHY** the test is doing what it is doing in every comment. -3. DO NOT explain **WHAT** the code is doing in comments. This information should be self-evident. +2. DO begin each comment section with the literal words "Given", "When", and "Then", just like the examples below. +3. DO explain **WHY** the test is doing what it is doing in every comment. +4. DO NOT explain **WHAT** the code is doing in comments. This information should be self-evident. The format looks like this: