Skip to content

Conversation

@KATO-Hiro
Copy link
Collaborator

@KATO-Hiro KATO-Hiro commented Jan 23, 2026

close #2989

See: #2919, #2830, #2836, #2835, #2837, #2838, #2776, #2785, #2797, #2920,

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive user-facing guide for adding ContestTableProviders, covering TDD workflow, implementation patterns, tests, and examples.
    • Removed multiple internal planning documents that outlined detailed test plans, mock strategies, and refactor roadmaps for various providers.

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

@coderabbitai
Copy link

coderabbitai bot commented Jan 23, 2026

Walkthrough

Removed eleven provider-specific test planning documents and added a single comprehensive TDD guide for implementing and testing ContestTableProvider implementations, consolidating prior plans into one actionable how-to document.

Changes

Cohort / File(s) Summary
Removed provider-specific plans
docs/dev-notes/2025-11-01/add_and_refactoring_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-11-03/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-11-06/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-11-12/add_provider_key_for_contest_table_provider/plan.md, docs/dev-notes/2025-11-14/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-11-15/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-11-19/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-12-03/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-12-10/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-12-11/add_tests_for_contest_table_provider/plan.md, docs/dev-notes/2025-12-17/add_tests_for_contest_table_provider/plan.md
Deleted eleven detailed planning documents. Removed content included test cases, mock data designs, multi-phase refactor plans, timelines, and lessons learned. No code or public API changes.
Added consolidated guide
docs/guides/how-to-add-contest-table-provider.md
Added a new TDD-style guide for adding ContestTableProvider implementations: skeletons, three implementation patterns (range-filter, single-source, composite-source), test design guidance, Vitest examples, mock strategies, Tessoku Book integration notes, and FAQs. Documentation-only addition (+711 lines).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through scattered notes today,
Collected plans and chased the fray,
Wove tests and guides into a strand,
A tidy map from paw and hand,
🥕 Ready for TDD to play.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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: consolidating dev-notes entries for add_tests_for_contest_table_provider into a summary.
Linked Issues check ✅ Passed The PR successfully consolidates multiple dev-notes planning files into a single comprehensive guide (docs/guides/how-to-add-contest-table-provider.md), addressing issue #2989's objective to reduce duplication.
Out of Scope Changes check ✅ Passed All changes are in scope: deletions of redundant plan.md documentation files and creation of a consolidated guide directly align with the consolidation objective stated in issue #2989.
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.


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

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 `@docs/guides/how-to-add-contest-table-provider.md`:
- Around line 111-115: The doc lists getContestRoundLabel() without parameters
but the example shows getContestRoundLabel(contestId: string); update the guide
to match the real interface: change the requirements bullet to
`getContestRoundLabel(contestId: string)` (or alternatively update the example
to the no-arg form if the interface is actually parameterless) and make the same
change for the other occurrence noted (lines 143-145) so the signature is
consistent across the document; reference getContestRoundLabel to locate and fix
both spots.
- Around line 175-203: The examples in this guide use the instance method
filter(...) but the base API expects setFilterCondition(...); update the example
implementations to call setFilterCondition and pass the predicate used in filter
(e.g., the lambda that extracts round via extractRound and checks 1..41) so
behavior matches the base class contract; also update any other example blocks
that use filter (the later occurrences of the same pattern) to use
setFilterCondition, and keep getMetadata, getDisplayConfig, and
getContestRoundLabel unchanged except for referencing the new filter setup.

Copy link
Collaborator Author

@KATO-Hiro KATO-Hiro left a comment

Choose a reason for hiding this comment

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

LGTM

@KATO-Hiro KATO-Hiro merged commit 3344949 into staging Jan 24, 2026
4 checks passed
@KATO-Hiro KATO-Hiro deleted the #2989 branch January 24, 2026 01:52
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.

[Docs] dev-notes の add_tests_for_contest_table_provider を一つに要約しましょう

2 participants