-
Notifications
You must be signed in to change notification settings - Fork 663
docs: add CLAUDE.md for Claude Code guidance #2564
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.
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
base: development
Are you sure you want to change the base?
Conversation
Add documentation file to help Claude Code instances understand the codebase architecture, build commands, and development patterns. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Rajan Maurya <rajanmaurya154@gmail.com>
📝 WalkthroughWalkthroughA new documentation file CLAUDE.md is added to the repository, providing comprehensive guidance for Claude Code. The document covers project overview, build instructions, architecture details, feature development workflow, technology stack, commit conventions, and branch policies. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Rajan Maurya <rajanmaurya154@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CLAUDE.md (1)
36-45: Specify a language for the fenced code block.The module structure listing (lines 36–45) is wrapped in a fenced code block without a language identifier. Specify
textas the language to comply with markdown formatting standards.🔎 Proposed fix
-``` +```text core/ - Shared layers (common, model, domain, data, database, network, datastore, designsystem, ui) feature/ - Feature modules (auth, client, loan, savings, groups, center, offline, etc.) cmp-android/ - Android app entry point cmp-desktop/ - Desktop JVM app cmp-ios/ - iOS app cmp-shared/ - Shared composition root cmp-navigation/ - Navigation and DI aggregation build-logic/ - Gradle convention plugins</details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 78b3242e0d99dedfb9f02887ccd518751a8b5da9 and c651fa0ef737e650ee1c8696d96058be756a24fb. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `CLAUDE.md` </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> <details> <summary>CLAUDE.md</summary> 36-36: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)</summary> * GitHub Check: PR Checks / Static Analysis Check </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>CLAUDE.md (1)</summary><blockquote> `1-82`: **Comprehensive and well-structured documentation.** The CLAUDE.md file provides clear, actionable guidance covering project overview, build commands, architecture, feature workflows, technologies, and conventions. The layout is logical and easy to navigate for Claude Code instances. The information aligns with the PR objectives that verified content accuracy and architecture correctness. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Summary
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.