This project uses AI agents to maintain code quality and accessibility standards. For detailed agent rules and guidelines, see:
When working on this project, always:
- Follow Path Reference Rules: Use absolute or project-relative paths (e.g.,
src/scanners/lighthouse-runner.js) - Use UTF-8 Encoding Only: Never use smart quotes, em dashes, or Windows-1252 characters
- Maintain Accessibility: This project benchmarks accessibility - ensure all generated HTML follows WCAG 2.2 AA standards
- Preserve Security: Always use
escapeHtml()when rendering user-controlled content in HTML - Follow Testing Practices: Run
npm testbefore committing changes - Disclose AI Usage: When you contribute to this project, update the
## AI Disclosuresection inREADME.mdto identify the LLM used, the version (if known), and the nature of your contribution (e.g., code implementation, documentation, planning). Do not list tools that were not used.
- Purpose: Daily benchmarking of U.S. government website quality using Lighthouse and ScanGov
- Key Components: Accessibility scanning, impact estimation, HTML report generation
- Testing: Node.js built-in test runner with unit, contract, and integration tests
- Build: Standard npm scripts, compatible with Node.js >= 22.19
For complete accessibility guidelines specific to this project, see ACCESSIBILITY.md.