docs: add testing guide for utility functions and coverage requirements#508
Open
extolkom wants to merge 1 commit into
Open
docs: add testing guide for utility functions and coverage requirements#508extolkom wants to merge 1 commit into
extolkom wants to merge 1 commit into
Conversation
|
@extolkom Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
closes #479
Summary
The client had a growing set of shared utility helpers but no documented pattern for how to test them. Contributors adding new helpers were skipping tests or writing them inconsistently because there was no reference to follow. This PR adds a clear, opinionated guide covering naming conventions, co-location, test runner setup, and a worked example.
Changes
docs/utils-testing-guide.md (new)
Documents the naming convention: test files are named helperName.test.ts and co-located with the helper they test
Explains the test runner setup and the command to run only util tests in isolation: pnpm test -- --testPathPattern=src/utils
Includes a full worked example for a simple helper showing describe block structure, individual test cases, edge case handling, and assertions
States the branch coverage expectation: pure helpers must have 100% branch coverage — every conditional path exercised