Skip to content

Conversation

@pcnudde
Copy link
Collaborator

@pcnudde pcnudde commented Feb 2, 2026

Description

Add claude code config file (this is also used by cursor).

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Quick tests passed locally by running ./runtest.sh.
  • In-line docstrings updated.
  • Documentation updated.

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 2, 2026

Greptile Overview

Greptile Summary

Added Claude Code/Cursor IDE configuration to help AI assistants understand the NVFlare project structure and development practices.

Key additions:

  • CLAUDE.md: Comprehensive configuration file covering project overview, common commands (testing, styling, documentation), architecture (Controller/Executor pattern, Shareable communication), package structure, and code style requirements (black, flake8, Apache 2.0 license headers)
  • .gitignore: Added CLAUDE.local.md to ignore list for personal developer preferences

The configuration is accurate and well-structured, referencing existing scripts (runtest.sh, build_doc.sh), correct directory structure, and valid testing conventions. The copyright year 2026 in the example is correct (current date: 2026-02-03, and 7 existing files already use 2026).

Confidence Score: 5/5

  • This PR is completely safe to merge with zero risk
  • Only adds documentation/configuration files with no code changes, all referenced commands and paths verified as accurate, gitignore entry properly prevents local config commits
  • No files require special attention

Important Files Changed

Filename Overview
.gitignore Added CLAUDE.local.md to gitignore for personal Claude Code configurations
CLAUDE.md Added comprehensive Claude Code configuration with project overview, commands, architecture, and style requirements

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Claude as Claude Code/Cursor
    participant Repo as Repository
    participant Config as CLAUDE.md

    Dev->>Claude: Opens nvflare repository
    Claude->>Repo: Reads repository files
    Claude->>Config: Loads CLAUDE.md configuration
    Config-->>Claude: Project overview, commands, architecture
    
    Dev->>Claude: Asks about project structure
    Claude->>Config: References package structure section
    Claude-->>Dev: Explains nvflare/ directory layout
    
    Dev->>Claude: Requests code changes
    Claude->>Config: Checks code style requirements
    Config-->>Claude: black (120 chars), Apache 2.0 license
    Claude->>Repo: Makes changes following guidelines
    
    Dev->>Claude: Wants personal preferences
    Claude-->>Dev: Suggests creating CLAUDE.local.md
    Dev->>Repo: Creates CLAUDE.local.md (gitignored)
    Note over Repo: .gitignore prevents commit of local config
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

@pcnudde
Copy link
Collaborator Author

pcnudde commented Feb 2, 2026

/build

1 similar comment
@pcnudde
Copy link
Collaborator Author

pcnudde commented Feb 3, 2026

/build

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

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