Skip to content

feat: AGENTS.md を新規作成(コード規約とアーキテクチャの明文化)#270

Open
taminororo wants to merge 3 commits intodevelopfrom
feat/kanba/269/agents-md
Open

feat: AGENTS.md を新規作成(コード規約とアーキテクチャの明文化)#270
taminororo wants to merge 3 commits intodevelopfrom
feat/kanba/269/agents-md

Conversation

@taminororo
Copy link
Copy Markdown
Collaborator

@taminororo taminororo commented May 1, 2026

対応Issue

resolve #269

概要

AGENTS.md をリポジトリルートに新規作成しました。AI コーディングアシスタント(Claude Code, CodeRabbit 等)と新規参加メンバーが SeeFT
のコードベースを理解するためのガイドです。

背景

  • ソロ開発状態でレビュー負担が増しており、AI レビュー Bot 導入で機械化したい
  • AI レビュー Bot は AGENTS.md を参照して PR レビューの判断材料にする
  • 8月から引き継ぎが始まるため、新メンバー向けのオンボーディング資料としても兼用する

構成

  1. Tech Stack - 3 コンポーネント構成(api / mobile / gas)とバージョン
  2. Commands - Makefile 主要ターゲット
  3. Architecture - 各コンポーネントのディレクトリ構造と責務
  4. Code Style - 言語別の新規コード向けルール(コード例+散文)
  5. Git Workflow - ブランチ命名・コミット・PR の規約
  6. Boundaries - Always Do / Ask First / Never Do の3層
  7. Known Transitional Issues - 混在ルールを正直に記載(SQLi Repository層のクエリ書式統一(プレースホルダ化と crud 経由統一) #266 含む)

参考にしたガイドライン

画面スクリーンショット等

ドキュメント追加のため、画面変更なし。

テスト項目

画面スクリーンショット等

ドキュメント追加のため、画面変更なし。

テスト項目

備考

本 PR のスコープ外

本 PR は AGENTS.md の初版作成のみが対象です。以下は別 PR で対応予定:

  • .coderabbit.yaml の追加(CodeRabbit 導入と日本語化)
  • .golangci.yml + GitHub Actions の追加(golangci-lint 導入、gosec で SQLi 検出)
  • analysis_options.yaml 強化(Flutter 静的解析)
  • .editorconfig の追加
  • Known Transitional Issues 各項目の解消(個別 issue 化)

設計上の補足

  • 行数は 200 行以内(185 行)に収めることで遵守率を確保
  • 判定マーク(✅/❌ 等)は使用せず、推奨パターンのコード例+散文での説明に統一
  • Boundaries セクションで「やるべき」「相談してから」「やらない」を 3 層で明示
  • Repository 層の SQL 文字列連結(約 41 件)は Repository層のクエリ書式統一(プレースホルダ化と crud 経由統一) #266 で別途進行中のため、本 PR では「過渡期事項として明記」のみ

Summary by CodeRabbit

  • Documentation
    • Added comprehensive development guidelines and standards documentation.

Note: This release contains internal developer documentation updates with no end-user visible changes.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 1, 2026

Warning

Rate limit exceeded

@taminororo has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 30 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cc2542ee-9b83-4aac-9740-9b358f9bb270

📥 Commits

Reviewing files that changed from the base of the PR and between 2f7b8bb and 534aa59.

📒 Files selected for processing (1)
  • AGENTS.md
📝 Walkthrough

Walkthrough

A new AGENTS.md documentation file is added to the repository root, establishing standardized development commands, architectural responsibilities across Go/Flutter/GAS components, and language-specific coding conventions including parameterized SQL, JSON handling patterns, nil checks, and destructive action confirmations.

Changes

Cohort / File(s) Summary
Documentation
AGENTS.md
New comprehensive specification document (189 lines) defining development commands, architectural boundaries, language-specific coding standards for Go, Flutter, and GAS, CI/review practices, and documented transitional rule conflicts.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

📜 A warren of rules, now clear as day,
With AGENTS.md to light the way,
Go, Flutter, GAS—each path defined,
New developers won't feel left behind! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: creating AGENTS.md to document code conventions and architecture. It accurately reflects the PR's primary objective.
Description check ✅ Passed The description covers all required sections from the template (issue link, overview, screenshots section, test items, notes) with detailed context about objectives, background, structure, and scope boundaries.
Linked Issues check ✅ Passed The PR successfully meets all coding-related requirements from issue #269: creates AGENTS.md with 6-chapter structure covering architecture, code conventions, and development workflow as specified.
Out of Scope Changes check ✅ Passed All changes are scoped to AGENTS.md creation as intended. The PR author explicitly documents out-of-scope items (linters, CI configs, .editorconfig) for future PRs, with no extraneous modifications.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/kanba/269/agents-md

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
Review rate limit: 0/1 reviews remaining, refill in 55 minutes and 30 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@taminororo taminororo requested a review from uchida189 May 1, 2026 13:07
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: 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

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7443c780-a81a-437e-b3fc-907e8b744ee6

📥 Commits

Reviewing files that changed from the base of the PR and between b9a9e9a and 2f7b8bb.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md Outdated
Copy link
Copy Markdown
Contributor

@uchida189 uchida189 left a comment

Choose a reason for hiding this comment

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

LGTM

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.

AGENTS.md を新規作成(コード規約とアーキテクチャの明文化)

2 participants