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,42 @@
|
||||
---
|
||||
name: ecommerce-brief-preparation
|
||||
description: 'Turn a rough ecommerce request into a normalized implementation brief. Use for clarifying requirements, asking targeted questions, and creating .ai/STORE-BRIEF.md before code generation.'
|
||||
argument-hint: 'Describe the store idea, constraints, and anything you already know'
|
||||
---
|
||||
# Ecommerce Brief Preparation
|
||||
|
||||
## When to use
|
||||
- Starting a new ecommerce project from a rough or incomplete idea.
|
||||
- Normalizing a user request before scaffolding code.
|
||||
- Creating a single source of truth for storefront, backend, admin panel, and design decisions.
|
||||
|
||||
## Goal
|
||||
- Ask only the high-impact questions that unblock architecture, UX, catalog, auth, cart, admin, integrations, and visual direction.
|
||||
- Convert the user's request into a structured file named .ai/STORE-BRIEF.md based on [STORE-BRIEF.md](./assets/store-brief-template.md).
|
||||
- Record explicit decisions, assumptions, and unresolved risks.
|
||||
|
||||
## Required workflow
|
||||
1. Parse the initial user request.
|
||||
2. Use [discovery question bank](./assets/discovery-question-bank.md) to ask only the questions that materially affect implementation.
|
||||
3. Decide whether the target is monorepo or split repos.
|
||||
4. Normalize the result into .ai/STORE-BRIEF.md.
|
||||
5. If the project is split across repos, create a repo-local .ai/STORE-BRIEF.md for the current repo and document the counterpart repo responsibilities.
|
||||
6. Do not scaffold application code in this step unless the user explicitly asks for both steps in one run.
|
||||
|
||||
## Output requirements for .ai/STORE-BRIEF.md
|
||||
- Project summary and business context.
|
||||
- Repo mode and delivery assumptions.
|
||||
- Storefront scope.
|
||||
- Admin panel or back office scope.
|
||||
- Auth and cart decisions.
|
||||
- Data model outline.
|
||||
- Integrations.
|
||||
- Visual direction and asset status.
|
||||
- Development questions answered.
|
||||
- Assumptions and open risks.
|
||||
- AGENTS.md creation plan.
|
||||
- Implementation phases for the build step.
|
||||
|
||||
## References
|
||||
- [discovery question bank](./assets/discovery-question-bank.md)
|
||||
- [STORE-BRIEF template](./assets/store-brief-template.md)
|
||||
Vendored
+44
@@ -0,0 +1,44 @@
|
||||
# Discovery Question Bank
|
||||
|
||||
Ask only the questions that materially change implementation. Prefer short batches.
|
||||
|
||||
## Product and business
|
||||
- What does the store sell and to whom.
|
||||
- Is this B2C, B2B, or mixed.
|
||||
- What market or country is the primary target.
|
||||
|
||||
## Repository and delivery mode
|
||||
- Is the target a monorepo or split repos.
|
||||
- If split repos, which repo is being worked on now.
|
||||
|
||||
## Storefront scope
|
||||
- Which pages are mandatory at launch.
|
||||
- Is customer auth required, optional, or excluded.
|
||||
- Is checkout needed, or is the target lead capture or quote request.
|
||||
- Should there be wishlist, favorites, recently viewed, reviews, blog, or CMS pages.
|
||||
|
||||
## Cart and order model
|
||||
- Is guest cart required.
|
||||
- Should the cart persist across devices.
|
||||
- Are pricing, promos, or SSR constraints strong enough to require cookie or server-backed cart.
|
||||
|
||||
## Admin and operations
|
||||
- Which admin modules are mandatory: catalog, orders, users, content, promos, settings, dashboards, roles.
|
||||
- Which staff roles are needed.
|
||||
- Are audit logs, bulk actions, import or export flows required.
|
||||
|
||||
## Catalog and data
|
||||
- Which entities exist: categories, brands, collections, attributes, variants, bundles.
|
||||
- Are stock tracking, preorder, backorder, or dynamic pricing needed.
|
||||
|
||||
## Integrations
|
||||
- Payments, delivery, CRM, ERP, analytics, email, storage, search.
|
||||
|
||||
## Design and assets
|
||||
- What visual direction, brand tone, and references exist.
|
||||
- Are production-ready assets available.
|
||||
- If not, should external image-generation prompts be prepared.
|
||||
|
||||
## Technical constraints
|
||||
- Preferred frontend stack if different from Next.js.
|
||||
- Localization, SEO, multi-currency, or compliance requirements.
|
||||
+69
@@ -0,0 +1,69 @@
|
||||
# STORE-BRIEF.md Template
|
||||
|
||||
## 1. Project Summary
|
||||
- Store name or working title
|
||||
- Business model
|
||||
- Target audience
|
||||
- Market or geography
|
||||
|
||||
## 2. Delivery Mode
|
||||
- Monorepo or split repos
|
||||
- Current repo scope
|
||||
- Assumptions about paired repo responsibilities when applicable
|
||||
|
||||
## 3. Technical Stack
|
||||
- Backend stack
|
||||
- Frontend stack
|
||||
- Database
|
||||
- Hosting or infrastructure assumptions
|
||||
|
||||
## 4. Storefront Scope
|
||||
- Required pages
|
||||
- Catalog behavior
|
||||
- Search, filters, sorting
|
||||
- Auth and account needs
|
||||
- Cart and checkout or lead flow
|
||||
|
||||
## 5. Admin or Back Office Scope
|
||||
- Required modules
|
||||
- Roles and permissions
|
||||
- Operational workflows
|
||||
|
||||
## 6. Data and Domain Model
|
||||
- Core entities
|
||||
- Relationships
|
||||
- Inventory, pricing, promotions, order states
|
||||
|
||||
## 7. Integrations
|
||||
- Payments
|
||||
- Delivery
|
||||
- CRM or ERP
|
||||
- Analytics
|
||||
- Media or storage
|
||||
|
||||
## 8. UX and Visual Direction
|
||||
- Brand tone
|
||||
- UI direction
|
||||
- Motion expectations
|
||||
- Mobile-first expectations
|
||||
|
||||
## 9. Assets and Content
|
||||
- Existing assets
|
||||
- Missing assets
|
||||
- External image prompt needs
|
||||
|
||||
## 10. Clarified Answers
|
||||
- List the questions asked and the confirmed decisions
|
||||
|
||||
## 11. Assumptions and Risks
|
||||
- Assumptions used for implementation
|
||||
- Open issues that can affect scope or architecture
|
||||
|
||||
## 12. AGENTS.md Plan
|
||||
- What AGENTS.md should include for this repo or monorepo
|
||||
|
||||
## 13. Build Phases
|
||||
- Phase 1: contracts and schema
|
||||
- Phase 2: storefront
|
||||
- Phase 3: admin panel or back office
|
||||
- Phase 4: polish, assets, QA
|
||||
Reference in New Issue
Block a user