Skip to content

chore: add CLAUDE.md file #122

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: add CLAUDE.md file #122

wants to merge 3 commits into from

Conversation

phatblat
Copy link
Member

@phatblat phatblat commented Jul 30, 2025

This PR adds a CLAUDE.md file to save some tokens on future Claude Code sessions.

While generating this, Claude found deviations in the data model implementation that should be revisited at some point. Logged in SDKS-1434

⏺ You're right to point that out. Looking at the actual data model implementations across the codebase, there are indeed variations in field
naming between platforms:

  1. Android/Kotlin uses: title, done, deleted
  2. JavaScript/React/Swift/Rust use: text, isCompleted
  3. Some implementations include a deleted field for soft deletes, others don't

This inconsistency across platforms could cause interoperability issues since these apps are supposed to sync data between devices. The
CLAUDE.md documentation correctly notes these variations, which is important for developers to understand when working across different
platform implementations.

@phatblat phatblat self-assigned this Jul 30, 2025
@Copilot Copilot AI review requested due to automatic review settings July 30, 2025 21:25
@phatblat phatblat requested a review from a team as a code owner July 30, 2025 21:25
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a CLAUDE.md file to provide context and guidance for Claude Code when working with this multi-platform Ditto SDK quickstart repository. The file serves as documentation to help reduce token usage in future Claude sessions by providing pre-loaded context about the repository structure, development commands, and architecture patterns.

Key changes:

  • Comprehensive documentation of the repository's multi-platform structure and purpose
  • Development command references for all supported platforms (Android, JavaScript, Rust, Flutter, .NET, C++)
  • Architecture overview including Ditto SDK integration patterns and platform-specific implementations
  • Notes about data model inconsistencies across platforms that need future attention

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