This repository was archived by the owner on Nov 21, 2025. It is now read-only.
Add useful information to claude.md #135
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add practical sections to make claude.md more actionable for developers: New sections added: - Quick Start Workflow: 5-step onboarding for new contributors - Installation & Setup: Detailed pip install commands with optional deps - Enhanced Project Structure: Complete directory layout with descriptions - Testing Guide: Commands, markers (slow/determinism/integration), parallel execution - Common Development Commands: Language tools, code quality, profiling - Performance Characteristics: Real metrics, bottlenecks, optimization tips - Troubleshooting: Common issues and solutions for imports, audio, tests - Domain Cheat Sheet: Quick reference for most-used operators (field, agents, audio, visual, graph) Benefits: - Faster onboarding for new developers - Clear testing workflow with pytest markers - Practical performance guidance - Self-service troubleshooting - At-a-glance operator reference All sections are concise and actionable, focused on getting developers productive quickly without overwhelming detail.
scottsen
deleted the
claude/update-claude-md-01Hwm72zXpHvSnhkoFAh5vqV
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add practical sections to make claude.md more actionable for developers:
New sections added:
Benefits:
All sections are concise and actionable, focused on getting developers productive quickly without overwhelming detail.