e2e-conventions

Define mandatory e2e test coverage rules for UI, filters, forms, and interactions.

26|4|Updated Apr 9, 2026
One-click install
npx skills add https://github.com/marmelab/crm-builder --skill e2e-conventions
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: e2e-conventions
Source: https://github.com/marmelab/crm-builder/tree/main/claudeConfig/.claude/skills/e2e-conventions
Command: npx skills add https://github.com/marmelab/crm-builder --skill e2e-conventions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents missing or inconsistent end-to-end (e2e) test coverage by giving clear rules for when tests are required, where they should live, and what should be verified.

Core Features & Use Cases

  • Clear e2e Trigger Rules: Defines when e2e tests are mandatory for UI, filters, forms, and user interactions, with an exception for pure CSS or DB migrations.
  • Consistent Test Placement: Standardizes the file naming and directory convention as e2e/task-xxx-<feature-name>.spec.ts to make tests easy to locate and validate.
  • Verification Expectations: Specifies that tests must exist, be syntactically valid, and be checked in CI without requiring agents to execute them locally.

Quick Start

Ask an AI agent to apply the e2e-conventions rules to a new ticket so it creates the correct e2e test file and ensures it is covered by CI syntax validation.

Frequently Asked Questions about e2e-conventions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
When are e2e tests mandatory for UI, filters, and forms?

E2e tests are mandatory for development affecting UI, filters, forms, or interactive behavior. Pure CSS changes and DB migrations are exceptions that do not require e2e test coverage.

How do I enforce consistent e2e test file naming and directory placement?

Standardize e2e test placement by using the e2e/task-xxx-<feature-name>.spec.ts file naming convention. This makes tests easy to locate and validate during CI pipeline syntax checks.

Do I need to execute e2e tests locally to verify TypeScript syntax?

No, local execution is not required. TypeScript e2e tests are verified via tsc syntax checks and validated for file existence in CI, ensuring coverage without running tests locally.

What is the best way to check if e2e test spec files exist in CI?

The best way is CI-focused existence validation that checks for task-scoped spec files. This ensures required e2e test files are present and syntactically valid without executing them.