Skip to content

docs: update README.md#35

Merged
shimomo merged 1 commit into
gh-pagesfrom
docs/update-readme
Sep 2, 2025
Merged

docs: update README.md#35
shimomo merged 1 commit into
gh-pagesfrom
docs/update-readme

Conversation

@shimomo
Copy link
Copy Markdown
Contributor

@shimomo shimomo commented Sep 2, 2025

README.md を全体的にリニューアルしました。

Summary by CodeRabbit

  • ドキュメント
    • 注意事項に GitHub Actions のスケジュール定義(cron.yml)に関する注記を追加し、更新頻度の理解を補強。
    • 概要で表記を統一(括弧内のスペース、"JSON 形式" の空白)。
    • エンドポイントの日付基準が JST(UTC+9)である旨を明記し、v1 の廃止を追記。
    • サンプル見出しに JST 表記を追加し、当日データ参照を today.json に更新。

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Sep 2, 2025

Walkthrough

README.mdで、時刻・日付がJST(UTC+9)基準であることの明記、サンプル表記のJST注記追加、today.json参照の更新、エンドポイントにv1廃止注記追記、用語表記(例: JSON 形式)の統一、及びGitHub Actionsスケジュールがcron.ymlで定義される旨の注意追記が行われました。

Changes

Cohort / File(s) Summary of Changes
Docs: README 表記・注記更新
README.md
JST(UTC+9)基準の明示、サンプル見出しへJST注記追加(本日の直前情報( JST〔UTC+9〕基準 ))、today.json参照追記、エンドポイントにJSTとv1廃止の注記追記、注意事項でcron.ymlによるスケジュール定義を明記、用語のスペース統一(例: JSON 形式

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

ぽん、と九つの鐘が鳴るよ
ぼくの足もJSTへぴょんと合わせる
today.jsonへひと跳び、ページは明るい
v1はそっと休む、穴で夢見るよ
cronが次の約束を刻むよ ⏰🐇


📜 Recent 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 890f4e2 and c25763b.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/update-readme

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@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: 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 6eeecea and 890f4e2.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

17-18: 表記統一(スペースの扱い・用語)は良いです

「ボートレース( 競艇 )」「JSON 形式」への統一は読みやすくなっています。他ドキュメントも同方針で統一されているかだけ確認してください。

@shimomo shimomo merged commit c589a2a into gh-pages Sep 2, 2025
4 checks passed
@shimomo shimomo deleted the docs/update-readme branch September 2, 2025 16:17
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