Skip to content

FT17 docs: schema-migrations.md + ADR cross-links + AGENTS + --help expand (#417) #420

@hideyukiMORI

Description

@hideyukiMORI

Source: FT17 (#417 / PR #418) F-2 / F-4 まとめ。

やること

docs/development/schema-migrations.md (新規)

  • ADR-0009 採用 (Option C: operator-applied) の紹介と TL;DR
  • 操作 workflow: SchemaDefinition 編集 → composer schema:diff > migration.sql → review → mysql / sqlite3 で apply
  • Add-table / Add-column の動作と SQL 例 (MySQL + SQLite)
  • Warning 経路 (drop / type change / rename / constraint) のリスト + 「operator hand-write の責任」
  • ergonomics: NeNe schema:diff を release pipeline に組み込む例
  • 関連 link (ADR-0005, ADR-0009, SchemaDiffer.php, cli/schemaDiff.php)

cli/schemaDiff.php --help expand (F-4)

短い "see docblock" から、MySQL / SQLite 各 example を含む multi-line usage に。
`--help` 出力に出すべき項目:

  • Usage 1 行
  • Options 表 (`--dsn`, `--user`, `--pass`, `--help`)
  • MySQL / SQLite 各 example
  • exit code の意味
  • "review-before-apply" 注意書き
  • ADR-0009 への doc link

ADR cross-link

  • ADR-0009 の "Implementation tracking" を merged PR # で update
  • ADR-0005 の "addressed by ADR-0009" 文を schema-migrations.md にも cross-link

AGENTS.md "Read First"

`docs/development/schema-migrations.md` への 1 行リンク

受け入れ条件

  • 新 doc 1 件
  • --help 出力が usage + example + exit code を含む
  • ADR-0009 implementation tracking 更新
  • AGENTS リンク

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions