skills.rest
adamreger
adamregerCOMMUNITY
Explore all skills by this author →
GitHub

project-guidelines-example

Provides a template for documenting project architecture, code patterns, testing, and deployment workflows.

2|Updated Feb 25, 2026
Search Tags:#testing#deployment#fastapi#coding standards#next.js#code patterns#project guidelines
One-click install
npx skills add https://github.com/adamreger/ecc-antigravity --skill project-guidelines-example-adamreger
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: project-guidelines-example
Source: https://github.com/adamreger/ecc-antigravity/tree/main/skills/project-guidelines-example
Command: npx skills add https://github.com/adamreger/ecc-antigravity --skill project-guidelines-example-adamreger

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Teams struggle to give AI agents consistent project context, leading to code that ignores established architecture, conventions, and testing requirements. This Skill provides a reusable template for capturing project-specific guidelines in one place. ## Core Features & Use Cases - Architecture Documentation: Records tech stack (Next.js, FastAPI, Supabase, Claude API) and service topology so agents understand the system layout. - Code Pattern Library: Defines canonical patterns for API responses, frontend fetch wrappers, Claude structured output, and React hooks. - Testing & Deployment Standards: Specifies pytest and React Testing Library conventions, coverage thresholds, and Cloud Run deployment checklists. - Use Case: When starting work on a full-stack TypeScript/Python application, an agent references this skill to generate code that matches the project's ApiResponse pattern, immutability rules, and 80% coverage requirement. ## Quick Start Ask the agent to follow the project guidelines skill when writing a new FastAPI endpoint with matching tests and response format.

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 project-specific guidelines for an AI coding agent?▼

Create a SKILL.md file documenting your architecture, file structure, code patterns, testing requirements, and deployment workflow. This template shows the sections to include, based on a real Next.js and FastAPI production application.

What should a project guidelines document include for full-stack development?▼

Include the tech stack, service architecture diagram, directory structure, canonical code patterns for API responses and data fetching, testing conventions with coverage targets, and a pre-deployment checklist with environment variable documentation.

How do I enforce consistent API response formats in FastAPI?▼

Define a generic ApiResponse Pydantic model with success, data, and error fields, plus ok() and fail() classmethods. Mirror the same interface in TypeScript so frontend and backend share one contract.

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

Yes, the structure is framework-agnostic. Replace the example stack, patterns, and commands with your own technologies while keeping the same sections for architecture, patterns, testing, and deployment.

What coding rules should AI agents follow in a production codebase?▼

This template specifies no emojis, immutability, test-driven development, 80% minimum coverage, small files of 200-400 lines, no console.log in production, proper error handling, and input validation with Pydantic or Zod.

Related Skills

Explore More Software Engineering Skills→
oobagioobagi

design

Generate design tokens and DESIGN.md for detected UI frameworks.

Community
Advanced
j7-devj7-dev
19

プロジェクトガイドラインスキル（例）

Document project guidelines for Python/FastAPI and Next.js/React with deployment workflows.

Community
Intermediate
patricio0312revpatricio0312rev
5

quality-gates-enforcer

Enforce CI quality gates for coverage, linting, type checks, and security in Node.js PR workflows.

Community
Advanced
ihj04982ihj04982

coding-standards

Enforce coding standards and best practices for TypeScript, JavaScript, React, and Node.js.

Community
Intermediate