Document Automation Code
1. Document Only What Helps
- Add class-level comments when the test role is not obvious.
- Add short comments before complex setup or custom filters.
- Do not add comments that restate the code literally.
2. Explain Boundaries
- Explain shared specs, auth helpers, builders, and virtualization seams.
- Explain why a test is tagged as smoke, contract, or integration when not obvious.
3. Troubleshooting
- Problem: The code already reads clearly. Fix: Do not add noise comments.