skills.rest
ibytechaos
ibytechaosCOMMUNITY
Explore all skills by this author →
GitHub

project-guidelines-example

Provides a project-specific skill template covering architecture, code patterns, testing, and deployment.

1|Updated Oct 11, 2025
Search Tags:#template#tdd#deployment#fastapi#next.js#code patterns#project guidelines
One-click install
npx skills add https://github.com/ibytechaos/claude --skill project-guidelines-example-ibytechaos
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-guidelines-example
Source: https://github.com/ibytechaos/claude/tree/main/plugins/everything-claude-code/skills/project-guidelines-example
Command: npx skills add https://github.com/ibytechaos/claude --skill project-guidelines-example-ibytechaos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams struggle to give AI assistants consistent project context—architecture, conventions, and workflows—so generated code often ignores established patterns. This Skill provides a complete, real-world template for authoring project-specific guidelines that keep AI output aligned with your codebase. ## Core Features & Use Cases - Architecture Documentation Template: Captures tech stack (Next.js, FastAPI, Supabase, Claude API), service diagrams, and file structure conventions. - Code Pattern Library: Includes reusable patterns for API responses (Pydantic/TypeScript), Claude structured output via tool calling, and custom React hooks. - Testing & Deployment Standards: Defines pytest and React Testing Library structures, coverage requirements, pre-deployment checklists, and Cloud Run deployment commands. - Use Case: A team onboarding AI assistance to a Next.js + FastAPI product copies this template, swaps in their own stack details, and instantly gives the AI consistent rules for code style, testing, and deployment. ## Quick Start Ask the AI to generate a project guidelines skill for your repository using this template's structure for architecture, code patterns, testing, and deployment.

Frequently Asked Questions about project-guidelines-example

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

FAQPage Schema
How do I create a project-specific skill for my codebase?▼

Copy this template's SKILL.md structure and replace the example content with your own architecture overview, file structure, code patterns, testing requirements, and deployment workflow. Keep the YAML frontmatter with name and description so the skill is discoverable.

What should a project guidelines document include?▼

Include an architecture overview with tech stack and services, a file structure map, reusable code patterns for APIs and frontend, testing requirements with commands, a deployment checklist, and critical rules like coverage minimums and immutability constraints.

How do I get structured output from the Claude API in Python?▼

Define a Pydantic model for the result, pass its JSON schema as a tool input_schema to client.messages.create, set tool_choice to force that tool, then parse the tool_use block from the response into your model.

Does this template work with frameworks other than Next.js and FastAPI?▼

Yes, the structure is framework-agnostic. The Next.js, FastAPI, and Supabase content is example material from a real production app; replace each section with your own stack while keeping the same section organization.

What testing standards does the template enforce?▼

It requires TDD with tests written before implementation, a minimum of 80 percent coverage, pytest with async fixtures for the backend, React Testing Library for the frontend, and Playwright for end-to-end tests.

Related Skills

Explore More Software Engineering Skills→
AdigunQAdigunQ

existing-repo

Analyze existing repositories and audit guardrails for JavaScript/TypeScript and Python projects.

Community
Advanced
freitasp1freitasp1

tdd-strict

Enforce Red-Green-Refactor cycles by blocking code generation without failing tests.

Community
Advanced
GGEduGGEdu

laravel-verification

Automate Laravel project verification for environment, code quality, and deployment readiness.

Community
Advanced
matlockxmatlockx

coding-standards

Enforce universal coding standards across Go, Rust, Swift, TypeScript, JavaScript, React, and Node.js.

Community
Advanced