Repository navigation
Make the README a guided setup with explicit rollback boundaries - #2
Merged
Merged
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
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.
The README now starts with the test-file API and walks developers through a complete pg/Vitest quick start before introducing Jest, Testcontainers provisioning, and other database clients. It distinguishes reusable setup from the declaration needed in each test file and explains fixture, test, and rollback ordering.
Responsibilities and rollback boundaries are explicit: real migrations and provider wiring remain application-owned, unrelated connections and HTTP activity are not automatically enrolled, and unsupported concurrency and runner integrations are identified. Testcontainers remains the recommended infrastructure pairing. Advanced compatibility details move after the usage walkthrough, TypeScript details are collapsible, and example links target the merged main branch.
Validation: extracted README snippets passed four real PostgreSQL tests under each of Jest and Vitest, plus TypeScript checking. Checked internal navigation, matching repository/package README copies, and npm package contents. Only the two README files change.