E2e Conventions
Testing & Qualitye2e-conventionsE2e Conventions is an Agent Skill for testing & quality published in the marmelab/atomic-crm repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
When to write e2e tests, where to put them, and how to verify them. Apply to any task touching UI, filters, forms, or interactions.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/marmelab/atomic-crm/blob/HEAD/.claude/skills/e2e-conventions/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/e2e-conventions, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
E2E Conventions
Reference for whether an e2e test is required, where it goes, and what it must assert. For the assertion/locator patterns inside the spec, see
Skill({skill: "playwright-testing"}).
When e2e tests are required
A change requires an e2e test if it touches any of:
- UI components or pages
- Filters or search
- Forms or user input
- Interactions (click, drag, keyboard)
Exception: pure CSS or a DB-migration-only change. State this explicitly in the task notes.
Where to put them
Under e2e/, named after the feature:
e2e/<feature-name>.spec.ts
If the work is tracked under a ticket id, you may prefix the file with it (e.g. e2e/TASK-001-deal-importance.spec.ts) to make it easy to find — but the ticket id is not required.
What to verify
Write the spec alongside the implementation. The reviewer checks that the spec exists and asserts the right thing. CI runs it — don't run it locally yourself.
Red Flags
- A UI/filter/form/interaction change with no
e2e/*.spec.tsadded. - Claiming the CSS/migration-only exception without saying so in the task notes.
- A spec placed outside
e2e/, or that asserts nothing user-visible. - Running the e2e suite locally instead of letting CI do it.
Verification
- If the change touches UI/filters/forms/interactions, a spec exists under
e2e/. - The spec is named after the feature (ticket-id prefix optional).
- The spec asserts the right user-visible behavior, using
playwright-testingpatterns. - Any CSS/migration-only exemption is stated explicitly in the task notes.