feat: AGENTS.md を新規作成(コード規約とアーキテクチャの明文化)#270
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Review rate limit: 0/1 reviews remaining, refill in 55 minutes and 30 seconds.Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Around line 15-25: Add explicit language identifiers to the fenced code blocks
in AGENTS.md: change the top command block that starts with the "make up
# docker compose up(API + DB + admin)" lines to use ```bash (or ```sh) and
change the directory-tree block that begins with "api/lib/" to use ```text (or
```bash); update any other plain triple-backtick blocks noted around lines 31–50
similarly so markdownlint MD040 is satisfied and editor syntax highlighting
works.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
対応Issue
resolve #269
概要
AGENTS.md をリポジトリルートに新規作成しました。AI コーディングアシスタント(Claude Code, CodeRabbit 等)と新規参加メンバーが SeeFT
のコードベースを理解するためのガイドです。
背景
構成
参考にしたガイドライン
agents.md - 6
領域構成、Boundaries 3 層、コード例優先
個の最重要ルールから始める
FinanSu/AGENTS.md,group-manager-2/AGENTS.md画面スクリーンショット等
ドキュメント追加のため、画面変更なし。
テスト項目
AGENTS.md がリポジトリルートに配置されている
GitHub 上で Markdown として正しくレンダリングされる
章立てに矛盾がない
既知の過渡期事項(SQLi Repository層のクエリ書式統一(プレースホルダ化と crud 経由統一) #266 / JSON キー命名混在 / エラー形式混在 等)が正直に記載されている
GitHub Blog: How to write a great
agents.md - 6
領域構成、Boundaries 3 層、コード例優先
Qiita: AGENTS.mdの書き方 - 200 行超で遵守率低下、5〜10
個の最重要ルールから始める
同種ドキュメント:
FinanSu/AGENTS.md,group-manager-2/AGENTS.md画面スクリーンショット等
ドキュメント追加のため、画面変更なし。
テスト項目
備考
本 PR のスコープ外
本 PR は AGENTS.md の初版作成のみが対象です。以下は別 PR で対応予定:
.coderabbit.yamlの追加(CodeRabbit 導入と日本語化).golangci.yml+ GitHub Actions の追加(golangci-lint導入、gosecで SQLi 検出)analysis_options.yaml強化(Flutter 静的解析).editorconfigの追加設計上の補足
Summary by CodeRabbit
Note: This release contains internal developer documentation updates with no end-user visible changes.