Skip to content

Add testing documentation#57

Open
grmbyrn wants to merge 1 commit intonautilus-cyberneering:mainfrom
grmbyrn:testing-documentation
Open

Add testing documentation#57
grmbyrn wants to merge 1 commit intonautilus-cyberneering:mainfrom
grmbyrn:testing-documentation

Conversation

@grmbyrn
Copy link
Collaborator

@grmbyrn grmbyrn commented Oct 23, 2025

Add Comprehensive Testing Documentation (Vitest & Playwright)

Related issue: [#54]


Summary

This PR adds full documentation for the project’s testing setup, clarifying how to run, organize, and extend tests for both unit (Vitest) and end-to-end (Playwright) coverage.
The goal is to help contributors understand the testing stack quickly and avoid confusion around configuration or runner conflicts.


Changes

  • 📝 Created docs/testing.md
    A detailed testing guide covering:

    • Overview of Vitest and Playwright usage
    • How to run unit and E2E tests
    • File organization and naming conventions
    • Example configurations (vitest.config.ts, playwright.config.ts)
    • Sample test code snippets (for both unit and E2E)
    • Troubleshooting common issues
  • 🔗 Updated README.md
    Added a new Testing section linking directly to the full guide.


Key Notes

  • Clarifies why Vitest excludes Playwright specs (separate runners & runtimes)
  • Provides ready-to-use commands for test execution and coverage
  • Documents prerequisites (e.g., npx playwright install, npm run dev)
  • Helps onboard new contributors faster with clear, reproducible examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant