Skip to content

Conversation

@david-waltermire
Copy link
Contributor

@david-waltermire david-waltermire commented Jan 8, 2026

Summary

  • Add CLAUDE.md with project guidance for Claude Code, documenting build commands, Maven profiles, architecture, package structure, command patterns, and git workflow
  • Add Claude settings.json for plugin configuration
  • Update .gitignore for Claude local files

Test plan

  • Verify CLAUDE.md content accurately describes the project
  • Confirm .gitignore properly excludes local Claude files

Summary by CodeRabbit

  • Chores
    • Added developer documentation covering project structure, build/run instructions, testing, and CLI guidance.
    • Introduced configuration to enable development plugins and register additional marketplaces for tooling.
    • Updated Git ignore rules to exclude local development and tooling config files.

Note: No changes to end-user functionality; these updates improve developer workflows.

✏️ Tip: You can customize this high-level summary in your review settings.

Add CLAUDE.md with project guidance for Claude Code including:
- Build commands and Maven profiles documentation
- Architecture overview with correct package structure
- Command pattern inheritance hierarchy
- Git workflow and worktree requirements
- Testing and dependency information

Also adds Claude settings.json for plugin configuration and
updates .gitignore for Claude local files.
@coderabbitai
Copy link

coderabbitai bot commented Jan 8, 2026

📝 Walkthrough

Walkthrough

Adds Claude Code integration artifacts: a repository guide (.claude/CLAUDE.md), a Claude configuration file (.claude/settings.json) enabling plugins and marketplaces, and .gitignore entries to ignore local Claude override files. No functional code changes.

Changes

Cohort / File(s) Summary
Claude documentation & config
\.claude/CLAUDE.md, \.claude/settings.json
New repository guide for Claude Code (build, architecture, CLI, testing, workflows) and a Claude settings file that enables multiple plugins and registers extra marketplaces.
Repository ignore patterns
\.gitignore
Added Claude-related ignores: CLAUDE.local.md and /.claude/settings.local.json under a Claude section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 I hopped in with a nibble and a cheer,

Wrote guides and settings so Claude may peer.
Plugins arranged, marketplaces set,
Local files hidden—no commit regret.
A tiny rabbit's tidy dev frontier.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adding Claude Code configuration files (CLAUDE.md, settings.json) and related .gitignore updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 911b8ce and 13edef9.

📒 Files selected for processing (1)
  • .claude/CLAUDE.md
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: david-waltermire
Repo: metaschema-framework/metaschema-java PR: 618
File: core/src/main/java/dev/metaschema/core/datatype/package-info.java:52-52
Timestamp: 2026-01-05T18:03:33.537Z
Learning: In metaschema-framework/metaschema-java, CLAUDE.md is the canonical coding-guidelines document and now specifies dev.metaschema.* as the Java package convention (updated in PR #618).
📚 Learning: 2026-01-05T18:03:33.537Z
Learnt from: david-waltermire
Repo: metaschema-framework/metaschema-java PR: 618
File: core/src/main/java/dev/metaschema/core/datatype/package-info.java:52-52
Timestamp: 2026-01-05T18:03:33.537Z
Learning: In metaschema-framework/metaschema-java, CLAUDE.md is the canonical coding-guidelines document and now specifies dev.metaschema.* as the Java package convention (updated in PR #618).

Applied to files:

  • .claude/CLAUDE.md
⏰ 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)
  • GitHub Check: Code
🔇 Additional comments (1)
.claude/CLAUDE.md (1)

1-184: Excellent documentation for Claude Code integration.

This is a comprehensive and well-structured guide for Claude Code when working with the oscal-cli repository. The document covers all essential areas—build commands, project architecture, package structure, command patterns, testing, dependencies, and available skills—in a clear, actionable format.

Key strengths:

  • Clear, mandatory Git worktrees requirement with helpful red flags (lines 91-135)
  • Proper markdown formatting with angle brackets for the repository URL (line 86) and correct relative path for the TESTING.md link (line 142)
  • Accurate package naming following the dev.metaschema.* convention
  • Comprehensive Maven profiles and build commands with clear examples
  • Well-organized Available Skills section providing plugin-specific guidance
  • Accessible language and structure for AI assistants

The previous markdown formatting issues have been addressed. This documentation will help Claude Code maintain consistency and best practices when contributing to the project.


Comment @coderabbitai help to get the list of available commands and usage tips.

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

🤖 Fix all issues with AI agents
In @.claude/CLAUDE.md:
- Line 86: Locate the bare URL
"https://github.com/metaschema-framework/oscal-cli" in the CLAUDE.md content and
replace the bare URL with markdown link syntax (e.g., use a [label](URL) form)
so the URL is wrapped as a proper Markdown link; ensure the link text is either
the same URL or a short descriptive label like "oscal-cli repository" and keep
the same URL target.
- Line 142: The markdown link to TESTING.md in CLAUDE.md is using a
same-directory target and therefore breaks; edit CLAUDE.md to update the
TESTING.md link so it uses a parent-directory relative target (pointing to the
repo root TESTING.md) instead of the current same-directory reference.
🧹 Nitpick comments (1)
.claude/CLAUDE.md (1)

79-82: Consider explicit Javadoc requirement in code style section.

The code style section mentions Java 11 target and SpotBugs annotations but doesn't explicitly reference the Javadoc requirement. Based on learnings from the metaschema-java repository, CLAUDE.md is the canonical coding-guidelines document and should emphasize the Javadoc style guide requirement: 100% coverage on public/protected members with proper param, return, and throws tags.

Consider adding a line to the Code Style section referencing the Javadoc requirement:

📝 Proposed enhancement
 ## Code Style

 - Java 11 target
 - Uses SpotBugs annotations (`@NonNull`, `@Nullable`) for null safety
+- All public/protected code requires 100% Javadoc coverage (see docs/javadoc-style-guide.md)
📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3b8e78a and 911b8ce.

📒 Files selected for processing (3)
  • .claude/CLAUDE.md
  • .claude/settings.json
  • .gitignore
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: david-waltermire
Repo: metaschema-framework/metaschema-java PR: 618
File: core/src/main/java/dev/metaschema/core/datatype/package-info.java:52-52
Timestamp: 2026-01-05T18:03:33.537Z
Learning: In metaschema-framework/metaschema-java, CLAUDE.md is the canonical coding-guidelines document and now specifies dev.metaschema.* as the Java package convention (updated in PR #618).
📚 Learning: 2026-01-05T18:03:33.537Z
Learnt from: david-waltermire
Repo: metaschema-framework/metaschema-java PR: 618
File: core/src/main/java/dev/metaschema/core/datatype/package-info.java:52-52
Timestamp: 2026-01-05T18:03:33.537Z
Learning: In metaschema-framework/metaschema-java, CLAUDE.md is the canonical coding-guidelines document and now specifies dev.metaschema.* as the Java package convention (updated in PR #618).

Applied to files:

  • .claude/CLAUDE.md
  • .gitignore
  • .claude/settings.json
📚 Learning: 2025-12-17T13:27:43.679Z
Learnt from: CR
Repo: metaschema-framework/metaschema-java PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-12-17T13:27:43.679Z
Learning: Applies to **/*.java : All code changes must follow the Javadoc style guide (docs/javadoc-style-guide.md). New code requires 100% Javadoc coverage on public/protected members. Modified code must add/update Javadoc on any members touched. All Javadoc must include param, return, throws tags in the correct order (BLOCKING)

Applied to files:

  • .claude/CLAUDE.md
🪛 markdownlint-cli2 (0.18.1)
.claude/CLAUDE.md

86-86: Bare URL used

(MD034, no-bare-urls)

⏰ 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)
  • GitHub Check: Code
🔇 Additional comments (3)
.gitignore (1)

22-24: Proper exclusion of local Claude configuration files.

The .gitignore entries correctly exclude local overrides while keeping versioned CLAUDE.md and settings.json files. The patterns are appropriately scoped.

.claude/CLAUDE.md (1)

1-160: Comprehensive and well-structured Claude Code guidance.

The CLAUDE.md documentation provides clear, actionable guidance across build processes, project architecture, Git workflows, and testing. The mandatory worktree section (lines 91-135) is particularly valuable for preventing common development mistakes. Package structure descriptions correctly use the dev.metaschema.* convention. Build commands are complete and helpful.

.claude/settings.json (1)

1-24: Verify plugin definitions in metaschema-framework/claude-plugins; superpowers marketplace confirmed.

The repositories are accessible (HTTP 200), and the superpowers marketplace is confirmed to exist. However, the metaschema-framework/claude-plugins repository could not be independently verified to contain valid Claude plugin definitions. Confirm that the five metaschema plugins (metaschema, metaschema-tools, oscal, oscal-tools, dev-metaschema) are actually published in that marketplace before relying on this configuration.

- Wrap bare URL in angle brackets for proper markdown formatting
- Fix TESTING.md link path to use relative parent directory
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