chore: add CodeRabbit configuration#71
Conversation
Configure CodeRabbit for Japanese reviews with PHP 8.4 / Result 型を 意識した path 別レビュー指示と PHPStan・actionlint 等の連携を追加。
|
Caution Review failedThe pull request is closed. Warning Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdded ChangesCodeRabbit Review Configuration
🎯 1 (Trivial) | ⏱️ ~3 minutes
✨ 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 @@
## main #71 +/- ##
===========================================
Coverage 100.00% 100.00%
Complexity 40 40
===========================================
Files 2 2
Lines 80 80
===========================================
Hits 80 80
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a .coderabbit.yaml configuration file to standardize AI code reviews for a PHP project, emphasizing PHP 8.4 syntax, Rust-inspired Result types, and TDD practices. The review feedback suggests refining the instructions to specify that readonly and final modifiers apply to classes to prevent AI hallucinations on interfaces, prioritizing SHA-1 hashes for GitHub Actions security, and configuring LanguageTool to respect path filters to minimize noise.
| - PHP 8.4 以上の構文・機能を前提にレビューする。 | ||
| - Rust の Result<T, E> に倣った API 設計を尊重し、Ok / Err / Result の不変条件を崩していないか確認する。 | ||
| - 例外による暗黙のエラー伝播ではなく、Result 型での明示的なエラーハンドリングを推奨する。 | ||
| - readonly / final / 型宣言（戻り値・引数・プロパティ）の徹底をチェックする。 |
There was a problem hiding this comment.
readonly や final はクラスにのみ適用可能な修飾子です。src/ 配下には Result.php インターフェースが含まれているため、AI がインターフェースに対してもこれらの適用を求めてしまう誤検知（ハルシネーション）を防ぐため、「クラスにおける」という限定を加えることを推奨します。
- クラスにおける readonly / final の適用、および型宣言（戻り値・引数・プロパティ）の徹底をチェックする。| - README の API 説明と src の実装が一致しているかを確認する。 | ||
| - path: ".github/workflows/**" | ||
| instructions: | | ||
| - 使用するアクションはバージョンを固定（SHA か明示的なタグ）しているかを確認する。 |
There was a problem hiding this comment.
GitHub Actions のセキュリティベストプラクティスでは、アクションの参照にはタグ（v4 など）ではなく、不変な SHA-1 ハッシュを使用することが推奨されます。現在の記述でも SHA に言及されていますが、優先順位を明確にすることで、よりセキュアなレビュー結果を得やすくなります。
- 使用するアクションはバージョンを固定（セキュリティ確保のため可能な限り SHA、困難な場合は明示的なタグ）しているかを確認する。| timeout_ms: 90000 | ||
| languagetool: | ||
| enabled: true | ||
| enabled_only: false |
There was a problem hiding this comment.
enabled_only: false の場合、path_filters で除外したファイル（キャッシュファイルやロックファイルなど）に対しても LanguageTool が実行される可能性があります。他のツールとの整合性を保ち、不要なノイズを避けるため、true に設定してフィルターを尊重させることを推奨します。
enabled_only: trueThere was a problem hiding this comment.
Pull request overview
CodeRabbit による自動レビューを有効化するため、プロジェクトルートに設定ファイル .coderabbit.yaml を追加する PR です。レビュー言語やレビュー方針、パス別の指示、利用する静的解析/リンタ系ツールをまとめて構成し、レビューの一貫性と自動化を強化します。
Changes:
.coderabbit.yamlを追加し、日本語レビュー・assertiveプロファイル・main 向け PR の auto review を設定src//tests//*.md/.github/workflows/に対して path 別のレビュー指示を追加- phpstan / actionlint / gitleaks / markdownlint / yamllint / languagetool 等のツール連携を有効化
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
.coderabbit.yamlをプロジェクトルートに追加し、CodeRabbit によるレビューを有効化language: ja)、assertiveプロファイル、main 向け PR の auto review を設定src/(PHP 8.4 / Result 型不変条件)、tests/(t-wada 流 TDD)、*.md、.github/workflows/に path 別の指示を付与Test plan
vendor/配下や.phpstan/などのキャッシュがレビュー対象外であることSummary by CodeRabbit