Update testing documentation

2025-09-03 14:23:10 -06:00
parent 3f1327b116
commit 25998e946f
7 changed files with 1055 additions and 787 deletions
@@ -0,0 +1,96 @@
+# Testing Documentation
+
+This directory contains comprehensive testing documentation for the CommunityRule platform.
+
+## 📚 Documentation Structure
+
+### 1. [testing-framework.md](./testing-framework.md) - **Main Guide**
+
+**Complete testing framework documentation** covering all aspects of testing:
+
+- Testing architecture and philosophy
+- Unit, integration, and E2E testing
+- Visual regression testing
+- Accessibility testing
+- Performance testing
+- CI/CD pipeline
+- Development workflow
+- Best practices and troubleshooting
+
+**Use this for**: Learning the testing framework, understanding architecture, comprehensive reference
+
+### 2. [testing-quick-reference.md](./testing-quick-reference.md) - **Quick Reference**
+
+**Essential commands and quick troubleshooting** for daily development:
+
+- Essential test commands
+- Current test status and metrics
+- Common test patterns
+- Troubleshooting solutions
+- Performance budgets
+- CI/CD pipeline overview
+
+**Use this for**: Daily development, quick commands, troubleshooting, reference
+
+### 3. [visual-regression-guide.md](./visual-regression-guide.md) - **Visual Testing Guide**
+
+**Focused guide for visual regression testing**:
+
+- Visual regression workflow
+- Snapshot management
+- Configuration and best practices
+- Troubleshooting visual test issues
+- CI/CD integration for visual tests
+
+**Use this for**: Visual regression testing, snapshot management, visual test troubleshooting
+
+## 🎯 How to Use These Documents
+
+### For New Team Members
+
+1. Start with **testing-framework.md** to understand the complete testing strategy
+2. Use **testing-quick-reference.md** for daily development
+3. Reference **visual-regression-guide.md** when working with visual tests
+
+### For Daily Development
+
+1. Use **testing-quick-reference.md** for commands and troubleshooting
+2. Reference **testing-framework.md** for detailed explanations
+3. Use **visual-regression-guide.md** for visual test workflows
+
+### For Troubleshooting
+
+1. Check **testing-quick-reference.md** for common solutions
+2. Use **testing-framework.md** for detailed troubleshooting
+3. Reference **visual-regression-guide.md** for visual test issues
+
+## 📊 Current Testing Status
+
+- **Unit Tests**: 94.88% coverage (exceeds 85% target)
+- **Integration Tests**: 5 comprehensive test suites
+- **E2E Tests**: 92 tests across 4 browsers
+- **Visual Regression**: 23 tests per browser
+- **Accessibility**: WCAG 2.1 AA compliance
+- **Performance**: Lighthouse CI with budgets
+
+## 🔄 Documentation Updates
+
+This documentation is maintained by the CommunityRule development team and updated regularly to reflect:
+
+- Current testing framework status
+- Best practices and patterns
+- Troubleshooting solutions
+- CI/CD pipeline changes
+- New testing features
+
+## 📚 Additional Resources
+
+- **Vitest Documentation**: https://vitest.dev/
+- **Playwright Documentation**: https://playwright.dev/
+- **React Testing Library**: https://testing-library.com/
+- **Lighthouse CI**: https://github.com/GoogleChrome/lighthouse-ci
+
+---
+
+**Last Updated**: December 2024  
+**Maintained by**: CommunityRule Development Team