| name | testing-guidelines |
| description | Guidelines for running and writing unit and E2E tests. Use this when asked to run tests, write tests, debug test failures, or verify code changes. Also use this before performing any merge commands or pushing code. |
Testing Guidelines
Core Philosophy
Test Core Functionality, Not Everything
- Focus on critical user paths and essential business logic
- Prioritize tests that catch regressions in key features
- Avoid over-testing trivial functionality or implementation details
- Ask: "If this breaks, will users notice?" - if yes, test it
Tests Must Pass Before Commit/Merge
- All existing tests must pass before committing changes
- Never skip or disable tests without explicit justification
- Broken tests block merges - fix them, don't ignore them
- Run the full test suite, not just tests for changed code
Tests Are Production Code
- Apply the same code quality standards to tests as production code
- Use clear, descriptive names that explain what is being tested
- Keep tests maintainable, readable, and well-organized
- Include strong typing, proper formatting, and meaningful comments
- Refactor tests when they become brittle or hard to understand
Running Tests
Always use the provided shell scripts:
./scripts/run-server-tests.sh
./scripts/run-e2e-tests.sh
.\scripts\run-server-tests.ps1
.\scripts\run-e2e-tests.ps1
These scripts handle environment setup, dependencies, and proper configuration.
Before Creating New Tests
- Check existing coverage - avoid duplication
- Review existing test patterns - follow established conventions
- Identify the right test type - xUnit for backend logic and routes, Playwright for user flows
Test Quality Standards
- Deterministic - Same result every run, no flaky tests
- Independent - No dependencies between tests
- Fast - Optimize for quick feedback loops
- Focused - One logical scenario per test
- Descriptive - Test names should read like specifications
Pre-Commit Checklist
- Run unit tests:
./scripts/run-server-tests.sh (or .\scripts\run-server-tests.ps1 on Windows)
- Run E2E tests if the UI changed:
./scripts/run-e2e-tests.sh (or .\scripts\run-e2e-tests.ps1 on Windows)
- Verify new functionality has appropriate test coverage
- Confirm no tests were broken or skipped
