Skip to content

docs(review): NENE2 流の self-review checklists を docs/review/ に追加する (#271)#291

Merged
hideyukiMORI merged 1 commit into
mainfrom
docs/271-self-review-checklists
May 21, 2026
Merged

docs(review): NENE2 流の self-review checklists を docs/review/ に追加する (#271)#291
hideyukiMORI merged 1 commit into
mainfrom
docs/271-self-review-checklists

Conversation

@hideyukiMORI
Copy link
Copy Markdown
Owner

Summary

Checklist set

Checklist Scope
`README.md` 索引 + when-to-use map
`rest-controller.md` REST handler / auto CSRF / generic envelope / per-user mapper
`html-controller.md` actionAction + Smarty / form CSRF helper / unauthorizedRedirect
`database.md` MySQL+SQLite parity / mapper / transactions / soft-delete
`openapi-contract.md` ADR-0003 generic envelope + per-endpoint examples + 自動契約テスト
`docs-and-adr.md` policy / ADR / roadmap / follow-ups.md 同期
`release-ci.md` workflow / branch protection / auto-merge / CI log 先行確認
`field-trial-report.md` FT methodology compliance

NENE2 にあって NeNe に surface が無い 2 件 (frontend.md, middleware-security.md) は意図的に省略。React frontend starter / bearer / rate limit / API key middleware が未実装で、checklist だけ作ると aspirational になるため。

Test plan

  • markdown rendering で全 8 file の section 構造が崩れない
  • `docs/review/README.md` の内部リンクが全部 resolve する
  • checklist 内の policy 参照パスが実在する (docs/api/openapi.yaml, docs/development/error-codes.md, docs/adr/0003-*.md, 等)
  • FT5 follow-up loop で実際に役立った "PHP fatal を先に log で確認" 教訓は release-ci.md にエンコード済み

🤖 Generated with Claude Code

)

姉妹 project NENE2 の docs/review/ pattern を NeNe に取り込む。
push 前に PR scope に合った checklist を歩いて、policy doc 参照 +
忘れがちな項目 (env override 形式、CSRF hook、schema parity、
generic envelope、FT report rules 等) を機械的にチェックできるよう
にする。

NENE2 8 ファイルから、NeNe-specific な surface に再構成した
6 checklist + 1 README + 1 FT report 専用 checklist の計 8 file:

- README.md         — when-to-use map + policy 参照集
- rest-controller.md — REST handler (auto CSRF gate / ApiResponse /
  generic envelope / per-user mapper / TransactionManager 等)
- html-controller.md — actionAction + Smarty (form POST / CSRF
  helper / unauthorizedRedirect hook / asset auto-discovery /
  Smarty escape 等)
- database.md       — schema parity (MySQL + SQLite) + mapper +
  TransactionManager + soft-delete / unique 制約のトレードオフ
- openapi-contract.md — ADR-0003 generic envelope + per-endpoint
  examples + 自動契約テスト
- docs-and-adr.md   — policy doc / ADR / roadmap / follow-ups.md
  の同期と source-of-truth 維持
- release-ci.md     — workflow / branch protection / auto-merge /
  CI 故障時の log 先行確認 (feedback-ci-debugging-discipline)
- field-trial-report.md — FT methodology compliance (ADR-0002 +
  template + friction taxonomy)

NENE2 にあって NeNe に該当する surface が無い 2 件 (frontend.md,
middleware-security.md) は意図的に省略。NeNe は React frontend
starter を持たず、bearer / API key / rate limit middleware も
未実装のため、checklist だけ先行させると aspirational になる。

docs/workflow.md と docs/CONTRIBUTING.md の Basic Flow に
「push 前に docs/review/ の checklist を歩く」step を挿入。

Closes #271.

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.

docs(review): NENE2 流の self-review checklists を docs/review/ にインポートする

1 participant