Skip to content

docs: packages/配下のCLAUDE.mdを統一テンプレートに移行#552

Merged
gn-t-k merged 1 commit intomainfrom
chore/claude/issue-551-20260221-0037
Feb 22, 2026
Merged

docs: packages/配下のCLAUDE.mdを統一テンプレートに移行#552
gn-t-k merged 1 commit intomainfrom
chore/claude/issue-551-20260221-0037

Conversation

@gn-t-k
Copy link
Owner

@gn-t-k gn-t-k commented Feb 21, 2026

closes #551

概要

packages/配下の7つのCLAUDE.mdを統一テンプレートに移行しました。

変更内容

  • 全パッケージで「機能→使い方→開発ガイド(任意)→制約と注意事項(任意)」の構造に統一
  • 全パッケージにコード例(importパス・呼び出しパターン・テストモックの使い方)を追加
  • 利用者向け情報と開発者向け情報を分離
  • 関連ADRを「制約と注意事項」に集約

Generated with Claude Code

@github-actions github-actions bot added the chore label Feb 21, 2026
@claude
Copy link

claude bot commented Feb 21, 2026

ドキュメント更新チェック結果

対象PR概要

配下の全7パッケージ(authentication, env, per-user-database, react-components, tailwind-config, turso, utilities)の CLAUDE.md を統一テンプレート(4セクション構成)に移行する、コード変更なしの純粋なドキュメントリファクタリング。


チェック結果

✅ 更新済み

  • packages/*/CLAUDE.md(7ファイル全て): 統一テンプレート(機能 / 使い方 / 開発ガイド / 制約と注意事項)への移行が完了している
  • ADR: アーキテクチャや技術スタックの変更なし → 更新不要
  • docs/project/overview.md: 機能追加・開発計画の変更なし → 更新不要
  • docs/model-based-ui-design/: UI設計・ユースケースの変更なし → 更新不要

⚠️ 要確認

1. 統一テンプレート構造が にルール化されていない

Issue #551 で定義されたテンプレート(4セクション構成と各セクションの役割)は、現在 配下のどのファイルにも記載されていません。

  • Issue がクローズされると、「なぜこの構造なのか」「新しいパッケージを追加した際にどのフォーマットに従えばよいか」の根拠が失われます
  • / のような形で package-claude-md.md を追加し、テンプレートの構造と各セクションの役割を記述することを推奨します

提案する対応(必須ではないが推奨):

.claude/rules/package-claude-md.md を新規作成

内容の例:

# packages/配下のCLAUDE.md記述規約

## セクション構成

- **機能**: エクスポートパスの一覧表(利用者向け)
- **使い方**: コード例付きの使い方説明(利用者向け)
- **開発ガイド**: 実装詳細・内部構造(開発者向け)
- **制約と注意事項**: 既知のリスク・ADRへのリンク(任意)

さらに、ルート CLAUDE.md## 開発ルール セクションにこのファイルへの参照を追加:

- @.claude/rules/package-claude-md.md : packages/配下のCLAUDE.md記述規約

総合評価

このPRの変更内容(7ファイルの統一テンプレートへの移行)は適切に実施されています。コードの変更がないため、ADRや機能ドキュメントの更新は不要です。

ただし、今回定めたテンプレート規約を将来も維持するためには、 へのルール化が有効です。このPRに含めるか、別Issueとして管理するかはご判断ください。

機能・使い方・開発ガイド・制約と注意事項の4セクション構造に統一。
各パッケージにコード例を追加し、利用者向け情報と開発者向け情報を分離した。

Co-authored-by: Gentoku Murakami <gn-t-k@users.noreply.github.com>
@gn-t-k gn-t-k force-pushed the chore/claude/issue-551-20260221-0037 branch from d5e766a to 336566f Compare February 22, 2026 06:27
@gn-t-k gn-t-k enabled auto-merge February 22, 2026 06:28
@claude
Copy link

claude bot commented Feb 22, 2026

ドキュメント更新チェックレポート

PR #552(packages/配下のCLAUDE.md統一テンプレート移行)のドキュメント更新漏れチェック結果です。


対象外ドキュメント(コード変更なし → 更新不要)

CLAUDE.md(ルート) — コード変更・プロセス変更なし。更新不要
.claude/rules/*.md — コーディング規約・テストルールへの影響なし
docs/architecture-decision-record/*.md — アーキテクチャ変更なし。ADR参照先のリンクも維持されている
docs/project/overview.md — 機能追加・開発計画の変更なし
docs/model-based-ui-design/ — UI設計・ユースケースへの影響なし


変更対象ドキュメント

packages/authentication/CLAUDE.md — 統一テンプレートに移行済み
packages/env/CLAUDE.md — 統一テンプレートに移行済み
packages/per-user-database/CLAUDE.md — 統一テンプレートに移行済み
packages/react-components/CLAUDE.md — 統一テンプレートに移行済み
packages/tailwind-config/CLAUDE.md — 統一テンプレートに移行済み
packages/turso/CLAUDE.md — 統一テンプレートに移行済み
packages/utilities/CLAUDE.md — 統一テンプレートに移行済み


要確認事項(情報の簡略化・削除)

リファクタリング過程で以下の情報が削除・簡略化されています。意図的な削除であれば問題ありませんが、念のため確認を推奨します。

⚠️ packages/authentication/CLAUDE.md — 「既知のリスクと制約」セクションが完全削除
削除された内容:

  • Account Linking: 信頼されたプロバイダー以外でのリンクはセキュリティリスク
  • トークン暗号化キーの漏洩: Per-User DBの全トークンが復号可能
  • Apple秘密鍵の管理: 有効期限(180日)内のローテーションが必要
  • セッション管理: Cookie属性(SameSite, Secure)設定ミスでCSRFリスク

ADR-019に記載はありますが、CLAUDE.mdからは参照できなくなりました。「制約と注意事項」セクションへの移動を検討してください。

⚠️ packages/tailwind-config/CLAUDE.md — カラートークン一覧が簡略化
, , , , , , , が表から削除されました。コンポーネント実装時に参照するトークン名が CLAUDE.md で確認できなくなっています。

⚠️ packages/env/CLAUDE.md — 実装詳細の削除

  • ヘルパーの説明が削除された(テスト作成時に参照するケースあり)
  • トラップ未実装( や が使えない)の制約が削除された

⚠️ packages/react-components/CLAUDE.md — vs の使い分け理由が削除
「React Aria Componentsの がレンダープロップを受け付けるため が必要」という理由の説明が削除されました。使い分けルールは残っていますが、理由がなければルールの意図が伝わりにくい可能性があります。


総合評価

「更新漏れ」に該当するものはありません。コード変更がないため他ドキュメントの更新は不要です。
上記の ⚠️ 項目は、統一テンプレートへの移行に伴う情報整理の結果であり、意図的な削除であれば問題ありません。もし削除が意図的でない場合は、「制約と注意事項」セクションへの追記を検討してください。

@gn-t-k gn-t-k merged commit b938b61 into main Feb 22, 2026
5 checks passed
@gn-t-k gn-t-k deleted the chore/claude/issue-551-20260221-0037 branch February 22, 2026 06:29
@github-actions
Copy link
Contributor

🗑️ Preview Environment Cleanup

✅ PR #552 のプレビュー環境をクリーンアップしました

結果 件数
削除成功 0
削除失敗 0
合計 0

PRがクローズされたため、関連するデータベースを削除しました。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

packages/配下のCLAUDE.mdを統一テンプレートに移行する

1 participant