Skip to content

Add CLAUDE.md documentation #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jhjaggars wants to merge 1 commit into from
Closed

Add CLAUDE.md documentation #242

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
I've analyzed the OCM API metamodel codebase and created a comprehensive CLAUDE.md file. The analysis revealed:

## Key Findings:

**Project Type**: Go-based code generation tool for API client libraries and specifications

**Architecture**:
- Model parser using ANTLR4 for custom DSL
- Core concepts package representing API elements
- Pluggable generators for Go, OpenAPI, and docs output
- Comprehensive test suite with integration testing

**Development Commands** (from Makefile):
- `make binary` - Build the metamodel CLI
- `make test` - Run all test suites
- `make verify` - Code quality checks
- `make generate` - Generate ANTLR parser

**Testing Strategy**:
- Unit tests with Ginkgo/Gomega
- Integration tests generating code from test models
- Separate validation for each generator type

The CLAUDE.md file provides future Claude Code instances with essential information about the codebase structure, common commands, testing approach, and code generation workflow without duplicating obvious details or including generic development practices.