docs: update README.md#35
Conversation
WalkthroughREADME.mdで、時刻・日付がJST(UTC+9)基準であることの明記、サンプル表記のJST注記追加、today.json参照の更新、エンドポイントにv1廃止注記追記、用語表記(例: Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README.md (4)
12-12: 更新間隔の根拠(cron.yml)へのリンクとUTC表記の追加を提案GitHub Actions のスケジュールはUTC基準です。本文にUTCである旨とcron.ymlへの直接リンクを入れると誤解防止になります。
-> 🕒 データはリアルタイム更新ではなく、**約30分間隔で更新**されます。( GitHub Actions のスケジュールは cron.yml を参照 )<br> +> 🕒 データはリアルタイム更新ではなく、**約30分間隔で更新**されます。※ GitHub Actions のスケジュールは**UTC基準**です([cron.yml を参照](https://github.com/BoatraceOpenAPI/previews/actions/workflows/cron.yml))。実行・反映は前後する場合があります。<br>
26-28: JST基準日の定義をもう一歩明確化(ゼロ詰めと日界)ゼロ詰めと日界の範囲を明示すると実装依存の解釈差を抑えられます。
-📅 YYYYMMDD → 年月日<br> -( 日付は日本標準時 JST〔UTC+9〕基準 ) +📅 YYYYMMDD → 年月日(ゼロ詰め、例:2025年7月5日 → 20250705)<br> +( 日付は日本標準時 JST〔UTC+9〕の 00:00〜23:59 を基準とします )
29-29: v1 廃止の根拠・時期・移行手順の追記を利用者向けに「いつ・なぜ・どう移行するか」を短文で補うと親切です。関連Issue/PR/Releaseノートがあればリンクを。
-※ 仕様上の欠陥により v1 は破棄されました。 +※ 仕様上の欠陥により v1 は廃止済みです(廃止日:YYYY-MM-DD)。理由の詳細と移行手順は「v1 廃止に関するお知らせ」を参照してください。
34-34: today.json の判定基準(JST)とキャッシュ注意を明記JSTでの日付判定とCDN/ブラウザキャッシュの影響をひと言補うと問い合わせ削減に効きます。
-- 本日の直前情報( JST〔UTC+9〕基準 ) +- 本日の直前情報( JST〔UTC+9〕基準。JSTの当日を today と判定します。CDN/ブラウザのキャッシュにより反映が遅れる場合があります )
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(1 hunks)
🔇 Additional comments (1)
README.md (1)
17-18: 表記統一(スペースの扱い・用語)は良いです「ボートレース( 競艇 )」「JSON 形式」への統一は読みやすくなっています。他ドキュメントも同方針で統一されているかだけ確認してください。
890f4e2 to
c25763b
Compare
README.md を全体的にリニューアルしました。
Summary by CodeRabbit