Add test coverage checklist, report template, and stack matrix for ecommerce project
- Created a test coverage checklist to ensure comprehensive testing of backend and frontend components. - Added a test report template to standardize reporting on test execution results and gaps. - Introduced a test stack matrix to guide the selection of testing tools and frameworks for backend and frontend. - Established a skill for repairing failing tests, including a failure triage checklist and a test repair template. - Documented recommended MCP stack for ecommerce development with FastAPI and React/Next.js. - Developed a detailed README outlining the project structure, agent capabilities, and recommended workflows. - Compiled a comprehensive workflow guide detailing step-by-step commands for project setup, testing, and SEO implementation.
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
---
|
||||
name: ecommerce-seo-implementation
|
||||
description: 'Implement SEO directly in an ecommerce codebase. Use for applying .ai/SEO-PLAN.md in code: metadata, schema markup, canonicals, sitemap, robots, internal linking, page templates, and crawl or index rules.'
|
||||
argument-hint: 'Describe whether to apply the full SEO plan or only specific SEO areas such as metadata, schema, category SEO, or technical SEO'
|
||||
---
|
||||
# Ecommerce SEO Implementation
|
||||
|
||||
## When to use
|
||||
- Applying an existing .ai/SEO-PLAN.md to a real ecommerce codebase.
|
||||
- Implementing SEO directly in frontend, backend, routing, templates, schema, metadata, and technical platform behavior.
|
||||
- Converting SEO recommendations into production-ready code and content structure.
|
||||
|
||||
## Goal
|
||||
- Execute SEO changes in code, not just describe them.
|
||||
- Use .ai/SEO-PLAN.md as the source of truth when it exists.
|
||||
- If .ai/SEO-PLAN.md is missing, derive the minimum required context from .ai/STORE-BRIEF.md or ask to prepare the SEO strategy first.
|
||||
|
||||
## Preconditions
|
||||
- Prefer having .ai/SEO-PLAN.md.
|
||||
- If .ai/SEO-PLAN.md is absent but the user explicitly wants implementation now, create a compact implementation assumption set from .ai/STORE-BRIEF.md and state the risk.
|
||||
|
||||
## Required workflow
|
||||
1. Read .ai/SEO-PLAN.md first when it exists.
|
||||
2. Read .ai/STORE-BRIEF.md and AGENTS.md if they exist to align implementation with the product scope and repo rules.
|
||||
3. Before serious backend or frontend edits, create a timestamped snapshot under .backup/ and keep that folder append-only.
|
||||
4. Audit the current codebase against [implementation checklist](./assets/implementation-checklist.md).
|
||||
5. Map required changes by page type using [page type SEO matrix](./assets/page-type-seo-matrix.md).
|
||||
6. Implement technical SEO behavior using [technical execution map](./assets/technical-execution-map.md).
|
||||
7. Apply metadata, canonicals, robots policy, sitemap generation, schema markup, internal linking, and template-level SEO content where appropriate.
|
||||
8. Validate that SEO changes do not create index bloat, duplicate pages, or structured data inconsistencies.
|
||||
9. Report what was implemented, what remains manual, and what should be measured after deployment.
|
||||
|
||||
## What this skill should implement
|
||||
- Metadata systems for homepage, category, collection, brand, product, article, and utility pages.
|
||||
- Canonical and noindex rules for filters, sort states, pagination, search results, cart, account, and utility routes.
|
||||
- XML sitemap generation and robots policy.
|
||||
- Structured data for organization, website, breadcrumbs, item lists, products, articles, FAQs, and local business when applicable.
|
||||
- Breadcrumbs and internal linking modules.
|
||||
- Category and product template support for SEO copy, FAQs, and content blocks when the architecture allows it.
|
||||
- Image SEO basics: alt text support, responsive image behavior, and index-safe media handling.
|
||||
- Performance-sensitive SEO work where it is practical within the current codebase.
|
||||
|
||||
## Constraints
|
||||
- Do not generate spammy or keyword-stuffed copy.
|
||||
- Do not index low-value filter combinations by default.
|
||||
- Do not implement fake ratings, fake reviews, or misleading schema.
|
||||
- Do not add SEO code that conflicts with the project routing or rendering model.
|
||||
|
||||
## Outputs
|
||||
- Implemented code changes in the project.
|
||||
- Optional update to .ai/SEO-PLAN.md when implementation assumptions change.
|
||||
- Clear summary of completed SEO work, remaining gaps, and validation steps.
|
||||
|
||||
## References
|
||||
- [implementation checklist](./assets/implementation-checklist.md)
|
||||
- [page type SEO matrix](./assets/page-type-seo-matrix.md)
|
||||
- [technical execution map](./assets/technical-execution-map.md)
|
||||
Vendored
+20
@@ -0,0 +1,20 @@
|
||||
# SEO Implementation Checklist
|
||||
|
||||
Before changing code, confirm the current project has or needs:
|
||||
|
||||
- Metadata generation by page type.
|
||||
- Canonical tags and noindex controls.
|
||||
- XML sitemap generation.
|
||||
- robots.txt policy.
|
||||
- Open Graph and social metadata.
|
||||
- Structured data by page type.
|
||||
- Breadcrumb markup and UI breadcrumbs.
|
||||
- Internal linking modules.
|
||||
- Category intro content or SEO content blocks.
|
||||
- Product content sections such as FAQs, specs, care, compatibility, or shipping info.
|
||||
- Search result and filter route indexation rules.
|
||||
- Pagination or infinite-scroll SEO handling.
|
||||
- Image component support for alt text, size hints, and optimized delivery.
|
||||
- Performance-sensitive rendering for money pages.
|
||||
|
||||
If any item is missing, decide whether to implement it now, defer it, or document it as blocked by architecture.
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
# Page Type SEO Matrix
|
||||
|
||||
## Homepage
|
||||
- Brand-level title and description.
|
||||
- Organization and WebSite schema.
|
||||
- Clear links to priority categories and collections.
|
||||
|
||||
## Category and collection pages
|
||||
- Unique title, meta description, H1, and intro copy strategy.
|
||||
- Breadcrumbs.
|
||||
- ItemList schema when appropriate.
|
||||
- Canonical rules for filters and sort states.
|
||||
- Internal links to related categories and featured products.
|
||||
|
||||
## Brand pages
|
||||
- Brand-specific copy and linked collections.
|
||||
- Canonical protection against overlap with categories or collections.
|
||||
|
||||
## Product pages
|
||||
- Product schema with real offer data.
|
||||
- Rich metadata with variant-aware handling.
|
||||
- FAQ or support content blocks when relevant.
|
||||
- Internal links to related products and parent categories.
|
||||
|
||||
## Editorial or guide pages
|
||||
- Article schema when relevant.
|
||||
- Strong internal links into commercial pages.
|
||||
- Intent-aligned headings and content sections.
|
||||
|
||||
## Utility pages
|
||||
- Cart, account, checkout, login, internal search, and thin utilities should usually be noindex.
|
||||
Vendored
+29
@@ -0,0 +1,29 @@
|
||||
# Technical Execution Map
|
||||
|
||||
## Metadata layer
|
||||
- Define where titles, descriptions, canonicals, Open Graph, and robots directives are generated.
|
||||
- Prefer centralized page-type SEO configuration over scattered hardcoded tags.
|
||||
|
||||
## Routing and index control
|
||||
- Ensure low-value routes can emit noindex or canonical rules.
|
||||
- Align filtered routes, sorted routes, search routes, and pagination with the SEO policy.
|
||||
|
||||
## Structured data layer
|
||||
- Use JSON-LD generated from real page data.
|
||||
- Keep schema close to the page data source to reduce drift.
|
||||
|
||||
## Sitemap and robots
|
||||
- Generate sitemaps only for valuable indexable URLs.
|
||||
- Exclude duplicates, noindex pages, and thin utility pages.
|
||||
|
||||
## Internal linking systems
|
||||
- Breadcrumbs, related content blocks, category cross-links, product recommendations, and editorial links should be intentional and reusable.
|
||||
|
||||
## Performance-sensitive work
|
||||
- Protect LCP, INP, and CLS while adding SEO features.
|
||||
- Avoid heavy client-only SEO logic for key landing pages.
|
||||
|
||||
## Validation
|
||||
- Check for duplicate titles or duplicate canonicals.
|
||||
- Check that schema matches visible content.
|
||||
- Check that robots and sitemap policy are coherent.
|
||||
Reference in New Issue
Block a user