docs: sync README, CHANGELOG, and CodeRabbit config with current codebase state#429
docs: sync README, CHANGELOG, and CodeRabbit config with current codebase state#429nanotaboada merged 2 commits intomasterfrom
Conversation
…base state Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Warning Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories. WalkthroughThis PR updates configuration and documentation files to .NET 10, refines CodeRabbit code review guidelines with stricter test naming conventions, and documents a validator scoping fix. Changes include Changes
Assessment against linked issues
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related issues
Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📋 Issue PlannerLet us write the prompt for your AI agent so you can ship faster (with fewer bugs). View plan for ticket: ✨ 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 |
There was a problem hiding this comment.
🧹 Nitpick comments (3)
.gitignore (1)
5-5: Consider a more flexible ignore pattern for Claude local files.The specific path
.claude/settings.local.jsonworks but only covers one file. If additional local files are added to.claude/in the future, they won't be ignored. Consider one of these alternatives:
- Ignore all local files:
.claude/*.local.*- Ignore the entire
.claude/directory:.claude/♻️ Proposed alternative patterns
Option 1: Ignore all
.local.*files in.claude/-.claude/settings.local.json +.claude/*.local.*Option 2: Ignore the entire
.claude/directory-.claude/settings.local.json +.claude/🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.gitignore at line 5, The current .gitignore entry is too specific ('.claude/settings.local.json') and should be made more flexible; replace or add a broader pattern so new local files are ignored — either use '.claude/*.local.*' to ignore any local-config files in the .claude directory or use '.claude/' to ignore the entire directory; update the .gitignore entry accordingly and commit the change..coderabbit.yaml (2)
350-352: Same segment count clarification applies here.For consistency with the earlier comment, the unit test generation instructions have the same "exactly 3 underscore-delimited segments" phrasing that doesn't quite match the 4-segment controller test pattern.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.coderabbit.yaml around lines 350 - 352, Update the naming guidance so the "Follow the two-pattern naming convention" block correctly distinguishes segment counts: change the Controller tests rule (the line starting "Controller tests: {HttpMethod}_{Resource}_{Condition}_Returns{Outcome}") to state exactly 4 underscore-delimited segments, and ensure the Service/Validator tests rule (the line starting "Service/Validator tests: {MethodName}_{StateUnderTest}_{ExpectedBehavior}") remains described as exactly 3 segments; keep the same examples and wording style so both lines consistently reference "exactly N underscore-delimited segments."
83-88: Minor clarification: The segment count description may be misleading.The instructions state "exactly 3 underscore-delimited segments", but:
- Controller pattern
{HttpMethod}_{Resource}_{Condition}_Returns{Outcome}has 4 parts (e.g.,Get_Players_Existing_ReturnsPlayers)- Service/Validator pattern
{MethodName}_{StateUnderTest}_{ExpectedBehavior}has 3 parts (e.g.,RetrieveAsync_CacheMiss_QueriesRepositoryAndCachesResult)Consider clarifying that controller tests have 4 segments while service/validator tests have 3 segments, or removing the specific count to avoid confusion.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.coderabbit.yaml around lines 83 - 88, Update the test-naming guidance to correct the segment count: clarify that controller test names follow the four-segment pattern "{HttpMethod}_{Resource}_{Condition}_Returns{Outcome}" (e.g., Get_Players_Existing_ReturnsPlayers) while service/validator tests follow the three-segment pattern "{MethodName}_{StateUnderTest}_{ExpectedBehavior}" (e.g., RetrieveAsync_CacheMiss_QueriesRepositoryAndCachesResult), or alternatively remove the explicit numeric requirement and just list the two patterns as examples; ensure the existing lines referencing "exactly 3 underscore-delimited segments" are replaced so the controller vs service/validator distinction is unambiguous.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.coderabbit.yaml:
- Around line 350-352: Update the naming guidance so the "Follow the two-pattern
naming convention" block correctly distinguishes segment counts: change the
Controller tests rule (the line starting "Controller tests:
{HttpMethod}_{Resource}_{Condition}_Returns{Outcome}") to state exactly 4
underscore-delimited segments, and ensure the Service/Validator tests rule (the
line starting "Service/Validator tests:
{MethodName}_{StateUnderTest}_{ExpectedBehavior}") remains described as exactly
3 segments; keep the same examples and wording style so both lines consistently
reference "exactly N underscore-delimited segments."
- Around line 83-88: Update the test-naming guidance to correct the segment
count: clarify that controller test names follow the four-segment pattern
"{HttpMethod}_{Resource}_{Condition}_Returns{Outcome}" (e.g.,
Get_Players_Existing_ReturnsPlayers) while service/validator tests follow the
three-segment pattern "{MethodName}_{StateUnderTest}_{ExpectedBehavior}" (e.g.,
RetrieveAsync_CacheMiss_QueriesRepositoryAndCachesResult), or alternatively
remove the explicit numeric requirement and just list the two patterns as
examples; ensure the existing lines referencing "exactly 3 underscore-delimited
segments" are replaced so the controller vs service/validator distinction is
unambiguous.
In @.gitignore:
- Line 5: The current .gitignore entry is too specific
('.claude/settings.local.json') and should be made more flexible; replace or add
a broader pattern so new local files are ignored — either use
'.claude/*.local.*' to ignore any local-config files in the .claude directory or
use '.claude/' to ignore the entire directory; update the .gitignore entry
accordingly and commit the change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: a80288ea-add4-4a7d-b79f-fca3e6320b91
📒 Files selected for processing (4)
.coderabbit.yaml.gitignoreCHANGELOG.mdREADME.md
|



Summary
Enums/,Middlewares/folders to src tree; addPlayerValidatorTests.csandtest/Utilities/subtree to test tree; adddotnet csharpier .to Command Summary; include Dependabot badge[Unreleased]with changes sincev2.0.0-centenario(validator fix [BUG] BeUniqueSquadNumber validator rejects all PUT requests for existing players #424, SonarCloud config, bug report template, codecov bump); fix[unreleased]comparison link (v1.1.0-bernabeu→v2.0.0-centenario); add missing[2.0.0 - centenario]link entryGiven_When_Thentest naming with the actual two-pattern convention used in this project.claude/settings.local.jsonTest plan
[Unreleased]entries match merged PRs sincev2.0.0-centenario.github/copilot-instructions.md🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores