Skip to content

Add CLAUDE.md: comprehensive framework guidance for AI assistants - #1

Merged
andrewsauder merged 2 commits into
mainfrom
claude/gcgov-framework-docs-tk1ny6
Jul 14, 2026
Merged

Add CLAUDE.md: comprehensive framework guidance for AI assistants#1
andrewsauder merged 2 commits into
mainfrom
claude/gcgov-framework-docs-tk1ny6

Conversation

@andrewsauder

Copy link
Copy Markdown
Member

Summary

Add a new CLAUDE.md file that serves as a fast-path reference guide for Claude (and other AI assistants) working on the framework or applications built on it. This document complements the existing README.md and readme/ directory with a more concise, structured mental model of the framework's architecture and conventions.

Key Changes

  • New file: CLAUDE.md (455 lines) containing:
    • Framework overview and purpose (REST API framework for Garrett County Government)
    • Repository layout and critical naming conventions (lowercase class names, PSR-4 structure)
    • Application contract requirements (required files, interfaces, entry points)
    • Exact request lifecycle sequence with hooks
    • Routing system and authentication guard flow
    • Controller response types and error handling patterns
    • MongoDB service deep dive (models, embeddables, static API, transactions, lifecycle hooks, attributes)
    • Configuration system (app.json, environment.json)
    • Framework services quick reference
    • Common recipes for CRUD endpoints, paged lists, CLI tasks
    • Gotchas and anti-patterns to avoid
    • Plugin/extension architecture
    • Plugin authoring guidelines
    • Build, test, and CI instructions
    • Cross-references to detailed documentation

Notable Details

  • Emphasizes the framework's lowercase class naming convention as deliberate and critical to PSR-4 autoloading
  • Highlights the MongoDB document-modeling system as the framework's standout feature and most complex component
  • Provides exact request lifecycle order with all hooks and their execution context (static vs instance)
  • Includes practical code examples for common patterns (transactions, model definition, CRUD, paged responses)
  • Documents the plugin discovery and registration mechanism
  • References the canonical starter templates and real consuming apps as sources of truth
  • Structured for quick lookup with numbered sections and tables for easy navigation

https://claude.ai/code/session_01VHMzRj65pSTe2yv6f9UAs8

claude added 2 commits July 14, 2026 15:15
Add Claude-facing documentation at the repo root describing the
architecture, request lifecycle, routing, controllers/response types,
the MongoDB modeling system (models, embeddables, factory API,
attributes, hooks, dispatch/cascade, validation, meta), services,
config schema, plugin/extension model, conventions, recipes, and
build/test/CI. Aimed at helping Claude work on the framework and on
apps built on it.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VHMzRj65pSTe2yv6f9UAs8
hybridauth/hybridauth <=3.12.2 is affected by advisory PKSA-27jb-7jhc-ynjm
(GHSA-r3hf-q3mf-7h6w, improper SSL certificate validation in the curl HTTP
client). v3.13.0 is the fixed release. Raise the constraint from ^3.8 to
^3.13 so only the patched version resolves; this also unblocks installs
under Composer versions that refuse advisory-affected packages.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VHMzRj65pSTe2yv6f9UAs8
@andrewsauder
andrewsauder merged commit 107b0f8 into main Jul 14, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants