docs: add section on testing style that we promote (#1645) #1649
Conversation
This file contains 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
matsales28
reviewed
Aug 30, 2024
Co-authored-by: Matheus Sales <matheus_usales@hotmail.com>
matsales28
approved these changes
Sep 6, 2024
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.
As outlined in my comment in #1645, this adds a section that explains the implementation-based testing style that
shoulda-matcherspromotes over behavior-/outcome-based style for the sake of providing clarity to newcomers to the gem, especially less experienced engineers.I've added it to the "Usage" section. It seemed appropriate there because this section also addresses the topic of
shouldvs.is_expected.towhich, to me, is a similar stylistic topic where opinions and promoted practices might differ.I'm absolutely open to feedback and adapting individual phrases as well as adding/removing parts as needed -- just let me know.