Skip to content

Conversation

MarkShawn2020
Copy link

Purpose

Add CLAUDE.md to improve the development experience when using Claude Code as a coding assistant.

What is CLAUDE.md?

Claude Code (by Anthropic) looks for this file to better understand the project structure and development workflows. Similar to how GitHub looks for CONTRIBUTING.md, Claude Code uses CLAUDE.md for context.

Contents

This file documents:

  • Project Overview: What Code Inspector does
  • Architecture: Monorepo structure and key components
  • Commands: Development, build, test workflows
  • Supported Ecosystems: Bundlers, frameworks, editors
  • Common Patterns: Transform pipeline, debugging approaches

Benefits

  • ✅ Helps Claude Code give better suggestions
  • ✅ Faster onboarding for developers using Claude Code
  • ✅ No impact on users or build process (documentation only)
  • ✅ Optional - only used by Claude Code users

Impact

  • No code changes
  • No dependencies added
  • Documentation only
  • Safe to merge

Alternative

If you prefer not to include this in the main repository, feel free to close this PR. The file will remain in my fork for developers who want it.

Add CLAUDE.md to help Claude Code (claude.ai/code) better understand:
- Project architecture and monorepo structure
- Key commands for development, building, and testing
- Supported ecosystems (bundlers, frameworks, editors)
- Common development patterns and debugging approaches

This improves the development experience when using Claude Code as a coding assistant.
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.

1 participant