Skip to content

Comments

Update CLAUDE.md#347

Merged
KaQuMiQ merged 1 commit intomainfrom
feature/claude
Jun 26, 2025
Merged

Update CLAUDE.md#347
KaQuMiQ merged 1 commit intomainfrom
feature/claude

Conversation

@KaQuMiQ
Copy link
Collaborator

@KaQuMiQ KaQuMiQ commented Jun 26, 2025

No description provided.

@coderabbitai
Copy link

coderabbitai bot commented Jun 26, 2025

Walkthrough

The documentation for the Draive framework was extensively revised and expanded. The setup instructions were clarified to specify activating the virtual environment before managing dependencies. The architecture section was rewritten to provide detailed explanations of Draive’s design principles, core components, and features, including state management and dependency injection. New sections describe integrations, functionalities, parameters, utilities, and helpers. The code style guidelines were broadened to cover import conventions, type usage, and exception handling. Testing practices were outlined, recommending pytest and mocking strategies. Numerous code examples were added to illustrate state management, resource handling, and testing patterns. No code or public API changes were made.

Possibly related PRs

  • Update README.md #329: Extensive documentation improvements focusing on updating README.md to clarify the project’s high-level purpose and user-facing messaging, related by theme but distinct in scope and target documentation file.

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0f3515a and 5d92e64.

📒 Files selected for processing (1)
  • CLAUDE.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
CLAUDE.md (5)
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Entry points for the framework include: simple generation via TextGeneration.generate() and ModelGeneration.generate(), tool integration via the @tool decorator, complex workflows via Stage composition and Agent systems, and setup via context managers with provider configs.
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Key architectural patterns include: immutable state (all state objects are frozen), context scoping (configuration flows through execution contexts), async-first design, composability (small focused components combine into complex workflows), and type safety (heavy use of generics and protocols).
🪛 LanguageTool
CLAUDE.md

[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...I, VLLM - Functionalities: High and low level interfaces and implementations of appli...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🪛 markdownlint-cli2 (0.17.2)
CLAUDE.md

12-12: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below

(MD022, blanks-around-headings)


13-13: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)


56-56: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

♻️ Duplicate comments (1)
CLAUDE.md (1)

57-60: Still missing blank line before the bullet list (MD032)

The list immediately follows the bold paragraph without an empty line, so markdown-lint keeps flagging it.
Insert a blank line before the first bullet.

 **ALWAYS use these types for collections in State, Config and DataModel classes:**
+
 - Use `Sequence[T]` instead of `list[T]` (becomes tuple)
📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d92e64 and 5f41e1d.

📒 Files selected for processing (1)
  • CLAUDE.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
CLAUDE.md (5)
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: The draive framework is a Python framework for LLM applications built on haiway for state management, emphasizing immutable State objects and dependency injection via context (ctx).
Learnt from: KaQuMiQ
PR: miquido/draive#338
File: src/draive/lmm/__init__.py:1-2
Timestamp: 2025-06-16T10:28:07.434Z
Learning: The draive project requires Python 3.12+ as specified in pyproject.toml with "requires-python = ">=3.12"" and uses Python 3.12+ specific features like PEP 695 type aliases and generic syntax extensively throughout the codebase.
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Entry points for the framework include: simple generation via TextGeneration.generate() and ModelGeneration.generate(), tool integration via the @tool decorator, complex workflows via Stage composition and Agent systems, and setup via context managers with provider configs.
Learnt from: CR
PR: miquido/draive#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-24T08:26:33.028Z
Learning: Key architectural patterns include: immutable state (all state objects are frozen), context scoping (configuration flows through execution contexts), async-first design, composability (small focused components combine into complex workflows), and type safety (heavy use of generics and protocols).
Learnt from: KaQuMiQ
PR: miquido/draive#327
File: src/draive/helpers/instruction_preparation.py:28-34
Timestamp: 2025-05-28T17:41:57.460Z
Learning: The draive project uses and requires Python 3.12+, so PEP-695 generic syntax with square brackets (e.g., `def func[T: Type]()`) is valid and should be used instead of the older TypeVar approach.
🪛 LanguageTool
CLAUDE.md

[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ...pytest with async support. Tests are in tests/ directory. - Mock dependencies w...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🪛 markdownlint-cli2 (0.17.2)
CLAUDE.md

58-58: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)

Comment on lines +50 to +51
- Uses pytest with async support. Tests are in `tests/` directory.
- Mock dependencies within scope using stubbed functionality state.
Copy link

Choose a reason for hiding this comment

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

🧹 Nitpick (assertive)

Unify imperative mood in testing bullets

Other bullets start with “Use”; this one starts with “Uses”. Align wording and add the article “the” for clarity.

-- Uses pytest with async support. Tests are in `tests/` directory.
+- Use pytest with async support. The tests are in the `tests/` directory.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Uses pytest with async support. Tests are in `tests/` directory.
- Mock dependencies within scope using stubbed functionality state.
- Use pytest with async support. The tests are in the `tests/` directory.
- Mock dependencies within scope using stubbed functionality state.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~50-~50: You might be missing the article “the” here.
Context: ...pytest with async support. Tests are in tests/ directory. - Mock dependencies w...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

🤖 Prompt for AI Agents
In CLAUDE.md around lines 50 to 51, the bullet point describing testing uses
"Uses" instead of the imperative "Use" like the other bullets and is missing the
article "the". Change "Uses pytest with async support" to "Use the pytest with
async support" to unify the imperative mood and improve clarity.

@KaQuMiQ KaQuMiQ merged commit e812282 into main Jun 26, 2025
5 checks passed
@KaQuMiQ KaQuMiQ deleted the feature/claude branch June 26, 2025 12:37
@coderabbitai coderabbitai bot mentioned this pull request Aug 8, 2025
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