Skip to content

update AGENTS.md - #28

Merged
susumutomita merged 2 commits into
mainfrom
feature/add-AGENTS.md
Nov 9, 2025
Merged

susumutomita merged 2 commits into
mainfrom
feature/add-AGENTS.md

Conversation

@susumutomita

@susumutomita susumutomita commented Nov 9, 2025 •

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Updated agent documentation with a cross-reference to related guidance for improved navigation.
    • Added a new MVP plan for the Tenant Management service (テナント管理サービス) detailing objectives, guardrails, TODOs, validation criteria, open questions, progress log, and next-step template.

@susumutomita
susumutomita enabled auto-merge (squash) November 9, 2025 21:14
@coderabbitai

coderabbitai Bot commented Nov 9, 2025 •

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

Walkthrough

Adds a one-line documentation reference in AGENTS.md to CLAUDE.md and adds a new, duplicated MVP plan section "テナント管理サービス MVP - 2025-11-09" to Plan.md with objectives, guardrails, TODOs, validation, open questions, progress log, and a next execution template.

Changes

Cohort / File(s) Change Summary
Documentation Reference
AGENTS.md
Added a single-line reference linking to CLAUDE.md.
MVP Plan Addition (duplicate)
Plan.md
Appended a new MVP plan section titled “テナント管理サービス MVP - 2025-11-09” including Objective, Guardrails (DynamoDB single-table, 100% test coverage, telemetry/PII handling, CI gate), Related Issue, TODOs, Validation, Open Questions, Progress Log, and a Next Execution Plan Template. A near-duplicate copy of the same MVP section was also added.

Sequence Diagram(s)

(omitted — changes are documentation/plan edits without new runtime control flow)

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Review notes:
    • Inspect Plan.md for the duplicated MVP section and confirm whether duplication is intentional; reconcile if not.
    • Verify the guardrails and constraints (DynamoDB single-table, test coverage, telemetry/PII) are stated consistently and clearly.
    • Check TODOs/open questions for actionable items and link accuracy.

Possibly related PRs

  • update AGENTS.md #28 — Adds the same reference line to AGENTS.md, indicating a direct overlap in the documentation change.

Poem

🐰 A twitch of whiskers, a tiny hop,
I left one line where paths all stop.
Plans penned in rows, twice on the page,
I stitched a roadmap, stage by stage.
Hop on, dear reader—let’s build that stage! 🎋

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'update AGENTS.md' is vague and generic, lacking specificity about what was actually changed in the file. Use a more descriptive title that explains the purpose of the update, such as 'Add reference to CLAUDE.md in AGENTS.md' to clarify the specific change made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9049cf and fbe42ab.

📒 Files selected for processing (1)
  • Plan.md (1 hunks)

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

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

@claude

claude Bot commented Nov 9, 2025

Copy link
Copy Markdown

PR Review: AGENTS.md Addition

概要 (Summary)

This PR adds a new AGENTS.md file that redirects to CLAUDE.md for AI agent development guidelines.


✅ Positive Aspects

  1. Discoverable Documentation: Creating an AGENTS.md file improves discoverability for AI agents and developers looking for agent-specific instructions.
  2. DRY Principle: Rather than duplicating content, this file appropriately references the canonical source (CLAUDE.md).
  3. Minimal Surface Area: Simple, focused change with low risk.

📋 Code Quality Review

Status: ✅ Generally Good with Minor Suggestions

File Content

# Refer to [CLAUDE.md](./CLAUDE.md)

💡 Suggestions for Improvement

1. Enhanced Documentation Value

The current content is very minimal. Consider adding a brief description to provide context:

# TenkaCloud AI Agent Development Guide

This project uses AI agents (Claude Code, etc.) for autonomous development.

**For complete AI agent development guidelines, see [CLAUDE.md](./CLAUDE.md).**

## Quick Links
- 🤖 [Claude Agent Development Playbook](./CLAUDE.md#-claude-agent-開発プレイブック)
- 📝 [Plan.md Protocol](./CLAUDE.md#planmd-運用ルール)
- 🧪 [TDD Guidelines](./CLAUDE.md#テスト駆動開発-tdd-プロトコル)
- 🔄 [Git Workflow](./CLAUDE.md#4-git-ワークフロー)

2. Consistency with Project Standards

According to CLAUDE.md, the project follows these principles:

  • ✅ Documentation updates are allowed
  • ⚠️ Missing context: No explanation in PR body about why this file is needed

Recommendation: Update the PR description to explain:

  • Why is AGENTS.md needed when CLAUDE.md already exists?
  • What problem does this solve?
  • Is this for a specific tool integration (MCP, Claude Code, etc.)?

3. Validation Checklist

Based on CLAUDE.md requirements, verify:

  • Linter: Run npm run lint (or bun run lint)
  • Type Check: Run npm run typecheck
  • Tests: Not applicable (documentation only)
  • Build: Run npm run build
  • CI Status: ⚠️ Unable to verify - please confirm CI is passing

🔒 Security Concerns

Status: ✅ No Security Issues

This is a documentation file with no executable code or sensitive information.


🚀 Performance Considerations

Status: ✅ N/A

Documentation change has no runtime performance impact.


🧪 Test Coverage

Status: ⚠️ Not Applicable (but verify build)

While unit tests aren't needed for documentation, please confirm:

  • npm run build succeeds (ensures no broken Markdown if processed)
  • Links resolve correctly: ./CLAUDE.md exists ✅

📊 Best Practices Alignment

CLAUDE.md Compliance Check

Guideline Status Notes
Plan.md Updated ⚠️ Unknown Should this be tracked in Plan.md?
Conventional Commits ✅ Yes Title follows convention
PR Description ❌ Empty Body is empty - should explain rationale
CI Verification ⚠️ Unknown Please confirm CI passed
Self-Review ❓ Did you review using gh pr diff?

🎯 Action Items

Required Before Merge:

  1. ✅ Add PR Description: Explain why AGENTS.md is needed
  2. ✅ Verify CI: Confirm all checks are green
  3. ⚠️ Consider Enhancement: Add more context to AGENTS.md (optional but recommended)

Optional Improvements:

  1. 💡 Add quick links section to AGENTS.md
  2. 💡 Update Plan.md if this is part of a larger effort
  3. 💡 Consider if README.md should reference AGENTS.md

📝 Suggested Commit Message (if amending)

docs: add AGENTS.md with reference to Claude agent guidelines

- Create AGENTS.md as discoverable entry point for AI agents
- Reference canonical documentation in CLAUDE.md
- Improve developer experience for AI-assisted development

Context:
- AI agents often look for AGENTS.md or similar files
- Centralize guidelines in CLAUDE.md while maintaining discoverability
- Part of improving AI agent integration workflow

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

🎬 Conclusion

Recommendation: ✅ Approve with Minor Changes

This is a straightforward documentation addition with low risk. The main improvement would be adding context to both the PR description and potentially the file content itself.

Merge Safety: Safe to merge once:

  1. PR description is added
  2. CI is confirmed green

Nice to Have: Enhanced content in AGENTS.md for better UX


Review conducted following CLAUDE.md guidelines
Reviewed by: Claude Code Agent

@susumutomita
susumutomita disabled auto-merge November 9, 2025 21:15
@susumutomita
susumutomita merged commit d21d7ba into main Nov 9, 2025
3 checks passed
@susumutomita
susumutomita deleted the feature/add-AGENTS.md branch November 9, 2025 21:16
@claude

claude Bot commented Nov 9, 2025

Copy link
Copy Markdown

🔍 Code Review - PR #28

📊 Overall Assessment

This PR has been merged and introduces a simple documentation cross-reference file. While the change itself is minimal, I've identified several areas for improvement based on the TenkaCloud project guidelines defined in CLAUDE.md.


✅ Positive Aspects

  1. Clear Intent: The AGENTS.md file serves as a clear redirect to the comprehensive CLAUDE.md
  2. Plan.md Updated: Progress was documented in Plan.md following the project's autonomous development protocol
  3. Simplicity: The change is straightforward and low-risk

⚠️ Issues & Concerns

1. Deviation from Git Workflow Guidelines (Priority: High)

Issue: The commits don't follow the Conventional Commits format specified in CLAUDE.md.

Current commits:

  • update AGENTS.md (appears twice)

Expected format per CLAUDE.md:

docs: AGENTS.md にクロスリファレンスを追加

- CLAUDE.md へのリダイレクトを設定
- AI エージェント向けドキュメント統合

Refs: Plan.md "テナント管理サービス MVP"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

Recommendation:

  • Update the Git Workflow section in CLAUDE.md to include commit message linting
  • Consider adding commitlint to enforce Conventional Commits format
  • Add this to the CI validation checks

2. Missing Validation Protocol (Priority: High)

Issue: No evidence that the validation checklist was executed before merge.

CLAUDE.md requires:

npm run lint          # または bun run lint
npm run typecheck     # または bun run typecheck
npm run test          # または bun run test
npm run test:coverage # カバレッジ 100% を確認
npm run build         # または bun run build

Recommendation:

  • Even for documentation changes, run the full validation suite
  • Add CI status verification to the PR template
  • Document the validation results in Plan.md progress log

3. Plan.md Sync Issue (Priority: Medium)

Issue: The Plan.md update includes a detailed implementation plan for "テナント管理サービス MVP" but this PR only adds AGENTS.md. The plan appears to be for Issue #27, not this PR.

Problems:

  • Plan.md entry doesn't match the actual work done in this PR
  • No progress log entry specifically for adding AGENTS.md
  • Creates confusion about what was actually implemented

Recommendation:

  • Separate Plan.md entries should exist for different features
  • This PR should have its own focused entry:
    ### AGENTS.md クロスリファレンス追加 - 2025-11-09
    
    **目的**: AI エージェント向けドキュメントを CLAUDE.md に統一
    
    **進捗ログ**:
    - [2025-11-09 21:13] AGENTS.md を作成し CLAUDE.md へリダイレクト
    - [2025-11-09 21:16] レビュー反映

4. Missing Test Coverage (Priority: Low)

Issue: While this is a documentation file, there's no validation that the markdown is well-formed or that the link is valid.

Recommendation:

  • Add markdown linting (markdownlint)
  • Add link checking in CI
  • Per CLAUDE.md: bun run lint_text should validate this

5. Self-Review Protocol Not Followed (Priority: Medium)

Issue: No evidence of the self-review checklist being completed per CLAUDE.md's "セルフレビュープロトコル":

Required checks:

  • コードがプロジェクトのスタイルに従っている
  • すべての検証チェックが通過
  • コメントアウトされたコードやデバッグ文がない
  • Plan.md が実装内容を正確に反映
  • コミットメッセージが明確
  • CI が Green

Recommendation:

  • Add a self-review checklist comment to the PR
  • Document self-review completion in Plan.md

🎯 Actionable Improvements

Immediate (for next PR):

  1. Follow Conventional Commits format strictly
  2. Execute and document full validation suite
  3. Create focused Plan.md entries per PR/feature
  4. Complete self-review protocol before requesting review

Short-term (automation):

  1. Add commitlint to CI pipeline
  2. Add markdown linting to bun run lint
  3. Create PR template with validation checklist
  4. Add link checking to CI

Long-term (process):

  1. Update CLAUDE.md with examples of good vs. bad PRs
  2. Add automated Plan.md format validation
  3. Create a PR readiness script that checks all requirements

📝 Code Quality Score

Criterion Score Notes
Code Quality N/A Documentation only
Test Coverage ⚠️ 0/5 No markdown linting
Documentation ✅ 4/5 Clear but could be more detailed
Git Workflow ❌ 1/5 Non-standard commit messages
Process Adherence ⚠️ 2/5 Plan.md misaligned, validation unclear
Overall ⚠️ 2.3/5 Process improvements needed

🔮 Next Steps

Since this PR is already merged:

  1. Create follow-up issue to implement the automation improvements listed above
  2. Update CLAUDE.md with clearer examples of the Git workflow
  3. Review Plan.md and separate the テナント管理サービス MVP section into its own PR/branch
  4. Apply lessons learned to PR Control Plane Tenant Management Service MVP #27 and future PRs

📚 References

  • CLAUDE.md sections:
    • Git ワークフロー (Line ~250)
    • 検証 (Validation) protocol (Line ~280)
    • セルフレビュープロトコル (Line ~370)
    • Plan.md 運用ルール (Line ~200)

Review conducted following TenkaCloud autonomous development protocol
🤖 Generated with Claude Code

@coderabbitai coderabbitai Bot mentioned this pull request Nov 11, 2025
susumutomita added a commit that referenced this pull request May 26, 2026
…yu.Mart (#1377)

## Why

Unicorn.Rentals is AWS GameDay's registered fictional e-commerce company.
Reusing it in an OSS / commercial competition platform invites IP risk.

## What

1. **Harness rule `no-aws-trademark-fictions`** flags `Unicorn.Rentals` /
   `Unicorn Rentals` (case-insensitive) in tracked text files. Exemption
   via `// allow-aws-fiction:` / `<!-- allow-aws-fiction: -->` markers.
2. **Submodule rename** (PRs #27 + #28 merged): `Unicorn.Rentals` →
   `Tenryu.Mart` (天龍 — Heaven-Dragon — fits the 天下一武道会 lore).
3. **Submodule pin bumped** to bedde98.
4. **README.md** catalog row updated.
5. **docs/lore/world.html** drops the AWS GameDay name-drop; explains the
   deliberate separation and points at the harness rule.

## Regression analysis

- 8 new harness rule tests pass; all 63 harness rule tests green.
- `Unicorn` substring no longer in any tracked file except the rule's own
  index.ts comment (exempted by the documented allow marker).
- No runtime behavior changes.

## Physical impact

NO-OP for CFn / Lambda / IAM. Catalog metadata (submodule), README, lore
HTML, and one new harness rule.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
susumutomita added a commit that referenced this pull request May 27, 2026
* chore(harness): ban Unicorn.Rentals (AWS GameDay IP) + rename to Tenryu.Mart

## Why

Unicorn.Rentals is AWS GameDay's registered fictional e-commerce company.
Reusing it in an OSS / commercial competition platform invites IP risk.

## What

1. **Harness rule `no-aws-trademark-fictions`** flags `Unicorn.Rentals` /
   `Unicorn Rentals` (case-insensitive) in tracked text files. Exemption
   via `// allow-aws-fiction:` / `<!-- allow-aws-fiction: -->` markers.
2. **Submodule rename** (PRs #27 + #28 merged): `Unicorn.Rentals` →
   `Tenryu.Mart` (天龍 — Heaven-Dragon — fits the 天下一武道会 lore).
3. **Submodule pin bumped** to bedde98.
4. **README.md** catalog row updated.
5. **docs/lore/world.html** drops the AWS GameDay name-drop; explains the
   deliberate separation and points at the harness rule.

## Regression analysis

- 8 new harness rule tests pass; all 63 harness rule tests green.
- `Unicorn` substring no longer in any tracked file except the rule's own
  index.ts comment (exempted by the documented allow marker).
- No runtime behavior changes.

## Physical impact

NO-OP for CFn / Lambda / IAM. Catalog metadata (submodule), README, lore
HTML, and one new harness rule.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* chore(submodule): bump catalog to 57a2855 (dragons endpoint rename)

Picks up TenkaCloudChallenge#29 — the `/api/v1/unicorns` → `/api/v1/dragons`
follow-up to PR #1377 that finished removing AWS GameDay carryover branding.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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