Skip to content

docs: add CLAUDE.md guidance for Claude Code integration - #1

Open
palomitaschilango wants to merge 1 commit into
devfrom
claude/claude-md-docs-srb5av
Open

palomitaschilango wants to merge 1 commit into
devfrom
claude/claude-md-docs-srb5av

Conversation

@palomitaschilango

Copy link
Copy Markdown
Owner

Issue for this PR

Closes #

Type of change

  • Bug fix
  • New feature
  • Refactor / code improvement
  • Documentation

What does this PR do?

Adds CLAUDE.md, a comprehensive guidance document for Claude Code (claude.ai/code) when working with this repository. This document serves as a quick reference for:

  • Project overview: OpenCode's architecture as a Bun/TypeScript/Effect monorepo with multiple applications (TUI, API server, web app, desktop app)
  • Common development commands: Installation, running dev servers, testing, building, and debugging workflows
  • Architecture documentation: Package dependency layering, application structure, supporting packages, session runtime details, and Effect-TS conventions
  • Code style and conventions: Module shape rules, naming conventions, import patterns, and references to authoritative style guides in AGENTS.md files
  • Testing and config: Testing conventions, tooling setup (oxlint, Prettier), and git/contribution workflow
  • Package-specific rules: Links to additional AGENTS.md files in packages that have specialized conventions

This document consolidates scattered guidance into a single entry point for AI assistants and new contributors, reducing friction when working with the codebase and ensuring consistency with the project's established patterns.

How did you verify your code works?

N/A — documentation only. The content is derived from existing project documentation (AGENTS.md, CONTRIBUTING.md, CONTEXT.md) and reflects current project structure and conventions.

Screenshots / recordings

N/A

Checklist

  • I have tested my changes locally
  • I have not included unrelated changes in this PR

https://claude.ai/code/session_011BQHJLcM6Si7bk4BXy5jqa

Documents the monorepo structure, schema/protocol/server/core dependency
layering, per-package conventions, Effect-TS patterns, test/build/lint
commands, and git/PR workflow for AI assistants working in this repo.
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