Skip to content

Commit

Permalink
Be even more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
@tgolen
tgolen authored Nov 19, 2024
1 parent 8bd9c6c commit a73f142
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions tests/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit a73f142

Please sign in to comment.