[Docs] Clarify Offline Test Execution in Beginner Contribution Guide
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 7
- Avg merge
- 39m
- Merged PRs (30d)
- 39
Description
- Labels:
good first issue,documentation,difficulty:beginner,area:core - Target File:
docs/CONTRIBUTING-BEGINNERS.md - Estimated Time: 5–10 minutes
- Difficulty: Level 1 (Beginner)
Why This Matters
New contributors often assume they need to provision a live Supabase database and configure Stripe webhooks just to test small UI or documentation changes. Explicitly reassuring them that all tests run offline eliminates onboarding hesitation.
Current Behavior
docs/CONTRIBUTING-BEGINNERS.md lists test commands, but could more prominently emphasize that unit tests mock all database dependencies locally.
Requested Change
Add a helpful callout box in docs/CONTRIBUTING-BEGINNERS.md under Step 10 explaining that npm test runs 100% offline in under 5 seconds with zero cloud setup needed.
Acceptance Criteria
- Callout box added using standard GitHub markdown syntax (
> [!NOTE]). - Explains that local tests do not require Supabase credentials.
Verification
node scratch/check-links.mjs
Contributor Notes
Great first issue for understanding PACT's contributor philosophy.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open docs/CONTRIBUTING-BEGINNERS.md and locate Step 10, where the test commands are listed. Add the requested GitHub Markdown NOTE callout explaining that local tests need no Supabase credentials or cloud setup, then run node scratch/check-links.mjs to verify the documentation links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- supabase
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 92/100