docs(consumer): create list of best practice rules #383
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
YOU54F
reviewed
May 12, 2025
|
|
||
| **❌ Bad:** | ||
| ```ts | ||
| .uponReceiving("a request for a list of products") // no provider state |
There was a problem hiding this comment.
maybe expand this to contain two tests with same description, one expecting a 200 / 404 or empty list
|
This looks great. for the bug catcher rule - we could show a decision engine response, and dependant on the status returned, the client does and returns something different. removing one of the tests would lean to an enum case and associated code tree not being tested |
|
All makes sense to me |
vwong
reviewed
May 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I took a shot at extracting the best practices in the video, and transposing them into a useful set of rules people could use to review tests.
I'm not 100% happy with them, but thought I'd share my thinking (the "Bug Catcher" rule I'm struggling to define clearly, but probably because it's quite a difficult thing to generalise but also give concrete examples concisely).