project-guidelines-examplelisted

# Project Guidelines Skill (Template) A copy-me template for a **project-specific** skill. Drop it into a real project as `.claude/skills/<project>-guidelines/SKILL.md`, then replace every section below with that project's actual details. Placeholders are written as `<YourProject>` / `<...>`. A project skill captures the things a generic reviewer or coding assistant can't guess: the stack, the directory layout, the house patterns, how tests and deploys are run, and the non-negotiable rules. --- ## When to Use Reference this skill when working on the project it describes. It should carry: - Architecture overview (stack + service topology) - File structure (where things live) - Code patterns (the house style, shown as short snippets) - Testing requirements (how to run tests and what to cover) - Deployment workflow (how a change reaches production) --- ## Architecture Overview Replace with your real stack. Example shape: - **Frontend**: `<framework>` (e.g. Next.js App Router + TypeScript) - **Backend**: `<framework>` (e.g. FastAPI + Pydantic) - **Database**: `<db>` (e.g. PostgreSQL) - **Deployment**: `<target>` (e.g. Cloud Run / Vercel) - **Testing**: `<tools>` (e.g. Playwright E2E, pytest, React Testing Library) Sketch the service topology so a newcomer sees how a request flows: ``` Client -> <frontend> -> <backend API> -> <database> / <external APIs> ``` --- ## File Structure Map the directories a contributor needs to find their way around: ``` <project>/