project-context

NaoyaTakashima's avatarfrom NaoyaTakashima

Project structure, conventions, and key patterns for this codebase

⭐0stars🔀0forks📁View on GitHub🕐Updated Jan 10, 2026
[Architecture Design]

When & Why to Use This Skill

This Claude skill acts as a central knowledge hub for codebase architecture, providing AI agents and developers with essential context on project structure, technical stacks, and coding conventions. By defining clear patterns and standards, it ensures architectural consistency and significantly accelerates the onboarding process for any software engineering project.

Use Cases

  • Codebase Onboarding: Rapidly orient AI agents or new team members by providing a clear map of the directory structure, tech stack, and core project goals.
  • Enforcing Coding Standards: Maintain high code quality by defining and referencing naming conventions (e.g., PascalCase for components) and standardized patterns for error handling.
  • Architectural Reference: Serve as a single source of truth for API response formats, shared utilities, and key file locations to reduce development friction.
  • Environment Configuration: Streamline setup and deployment by documenting required environment variables and infrastructure dependencies.
nameproject-context
descriptionProject structure, conventions, and key patterns for this codebase
allowed-toolsRead, Grep, Glob

Project Context

Project Overview

[Describe what this project does]

Tech Stack

  • Language: [e.g., TypeScript, Python]
  • Framework: [e.g., Next.js, FastAPI]
  • Database: [e.g., PostgreSQL, MongoDB]
  • Infrastructure: [e.g., AWS, Vercel]

Directory Structure

src/
├── components/    # UI components
├── lib/           # Shared utilities
├── services/      # Business logic
└── api/           # API routes

Naming Conventions

  • Components: PascalCase (e.g., UserProfile.tsx)
  • Utilities: camelCase (e.g., formatDate.ts)
  • Constants: SCREAMING_SNAKE_CASE
  • Database tables: snake_case

Key Patterns

Error Handling

// Always use Result type for operations that can fail
type Result<T, E = Error> = { ok: true; value: T } | { ok: false; error: E };

API Response Format

interface ApiResponse<T> {
  data: T;
  meta?: { page: number; total: number };
  error?: { code: string; message: string };
}

Important Files

  • src/config/index.ts - Application configuration
  • src/lib/db.ts - Database connection
  • src/middleware/auth.ts - Authentication middleware

Environment Variables

Required:

  • DATABASE_URL - Database connection string
  • API_KEY - External API key

Optional:

  • LOG_LEVEL - Logging verbosity (default: info)