e2e-conventions
GitHub定义端到端测试的编写规范,明确触发场景、存放路径及断言要求。用于审查涉及UI、表单或交互的代码变更是否包含必要的E2E测试,确保符合项目约定。
Trigger Scenarios
Install
npx skills add marmelab/atomic-crm --skill e2e-conventions -g -y
SKILL.md
Frontmatter
{
"name": "e2e-conventions",
"description": "When to write e2e tests, where to put them, and how to verify them. Apply to any task touching UI, filters, forms, or interactions."
}
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.
Version History
- 167a4cd Current 2026-08-20 13:19


