docs(claude): consolidate project documentation into CLAUDE.md (#335)#339
Conversation
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 41 minutes and 18 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughConsolidates AI agent project guidance from ChangesDocumentation Consolidation and Alignment
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Assessment against linked issues
Possibly related issues
Possibly related PRs
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📋 Issue PlannerBuilt with CodeRabbit's Coding Plans for faster development and fewer bugs. View plan used: ✨ 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #339 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 32 32
===========================================
Files 3 3
Lines 90 90
Branches 8 8
===========================================
Hits 90 90 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
.coderabbit.yaml (2)
240-241:⚠️ Potential issue | 🟠 Major | ⚡ Quick winAlign allowed Conventional Commit types with documented invariants.
pre_merge_checks.title.requirementscurrently omitsciandperf, which conflicts withCLAUDE.mdand may incorrectly warn on valid PR titles.Suggested patch
- - Use Conventional Commits format (feat:, fix:, chore:, docs:, test:, refactor:) + - Use Conventional Commits format (feat:, fix:, chore:, docs:, test:, refactor:, ci:, perf:)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.coderabbit.yaml around lines 240 - 241, pre_merge_checks.title.requirements currently lists allowed Conventional Commit types but omits "ci" and "perf", causing false warnings; update the pre_merge_checks.title.requirements configuration to include "ci" and "perf" alongside existing types (e.g., feat, fix, chore, docs, test, refactor) so it matches the invariants in CLAUDE.md and accepts valid PR titles. Ensure the change updates the allowed types array/string used by the title check logic referenced by pre_merge_checks.title.requirements.
110-114:⚠️ Potential issue | 🟠 Major | ⚡ Quick winFix test DB guidance drift (
H2vs SQLite in-memory).This path instruction contradicts the project’s documented test database strategy and will push reviewers toward wrong recommendations.
Suggested patch
- path: "src/test/resources/application.properties" instructions: | - - Verify H2 in-memory database for tests + - Verify SQLite in-memory database for tests - Check test-specific configurations - Ensure proper test isolation settingsBased on learnings, this repository standard is in-memory SQLite for tests.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.coderabbit.yaml around lines 110 - 114, The guidance text under the YAML entry whose path is "src/test/resources/application.properties" currently references H2; update the "instructions" value to align with the repository standard (in-memory SQLite) by replacing any "H2" mentions with "SQLite" and changing checklist items to: verify in-memory SQLite for tests, check test-specific SQLite configurations (e.g., JDBC URL like jdbc:sqlite::memory: or equivalent), ensure proper test isolation and teardown for SQLite, and confirm any ORM/connection-pool settings are compatible with SQLite in-memory mode; keep the same YAML key "instructions" and the same path entry but update the bullet content to these SQLite-focused checks.Source: Learnings
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In @.coderabbit.yaml:
- Around line 240-241: pre_merge_checks.title.requirements currently lists
allowed Conventional Commit types but omits "ci" and "perf", causing false
warnings; update the pre_merge_checks.title.requirements configuration to
include "ci" and "perf" alongside existing types (e.g., feat, fix, chore, docs,
test, refactor) so it matches the invariants in CLAUDE.md and accepts valid PR
titles. Ensure the change updates the allowed types array/string used by the
title check logic referenced by pre_merge_checks.title.requirements.
- Around line 110-114: The guidance text under the YAML entry whose path is
"src/test/resources/application.properties" currently references H2; update the
"instructions" value to align with the repository standard (in-memory SQLite) by
replacing any "H2" mentions with "SQLite" and changing checklist items to:
verify in-memory SQLite for tests, check test-specific SQLite configurations
(e.g., JDBC URL like jdbc:sqlite::memory: or equivalent), ensure proper test
isolation and teardown for SQLite, and confirm any ORM/connection-pool settings
are compatible with SQLite in-memory mode; keep the same YAML key "instructions"
and the same path entry but update the bullet content to these SQLite-focused
checks.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: f3b28558-bf50-4277-8ec1-5b432d390ca3
📒 Files selected for processing (4)
.coderabbit.yaml.github/copilot-instructions.mdCHANGELOG.mdCLAUDE.md
💤 Files with no reviewable changes (1)
- .github/copilot-instructions.md
…#335) Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
|
1 participant
Summary
CLAUDE.mdstub (which delegated to.github/copilot-instructions.mdvia an@include) with the full, self-contained contentdocs/adr/(implemented in Implement Architecture Decision Records (ADRs) #299)CLAUDE.mdand create/amend the relevant ADR when a commit introduces an architectural decision.github/copilot-instructions.md(content fully merged intoCLAUDE.md).coderabbit.yaml: document intentional no-expiry cache behaviour in services path instruction; pointknowledge_base.code_guidelinesand the "sync documentation" finishing touch toCLAUDE.mdTest plan
./mvnw clean test— 41/41 tests pass, no regressionsCloses #335
🤖 Generated with Claude Code
This change is
Summary by CodeRabbit