Skip to content

docs: コーディング規約集 docs/coding-conventions.md を新設して CLAUDE.md から参照 - #52

Merged
thawk105 merged 1 commit into
masterfrom
docs-coding-conventions
May 13, 2026
Merged

docs: コーディング規約集 docs/coding-conventions.md を新設して CLAUDE.md から参照#52
thawk105 merged 1 commit into
masterfrom
docs-coding-conventions

Conversation

@thawk105

Copy link
Copy Markdown
Owner

リポジトリ固有のコーディング規約と、ファイル種別ごとに 指摘される前に 適用すべき業界 best practice を 1 か所にまとめる。CLAUDE.md からは "Read before editing" として参照。

動機

#51 で devcontainer に `htop` を追加した際、`apt-get install` リストの末尾に追加してしまい、ユーザーから「Docker docs の Sort multi-line arguments は周知の best practice。指摘されないと適用しないのは怠慢」とフィードバック。

レビューで毎回指摘するより、リポジトリ規約としてドキュメント化 した方が:

  • 長期的なレビューコストが低い (1 度書けば次から自動的に参照される)
  • Claude / 新規 contributor 両方に効く
  • 「なぜそうするか」の理由も記録されて、規約が形骸化しにくい

構成

`docs/coding-conventions.md` (新規) — ファイル種別ごとの規約集:

`CLAUDE.md` 冒頭に "Read before editing" 節を追加して docs を必読指定。

このドキュメント自体のルール

  • 初版は薄い、気付いたものから追記する
  • 新しい best practice 違反を見つけたら、まずこの docs に追記して規約化する
  • 規約の「理由」を短く併記する
  • 例外を見つけたら例外もここに書く

Test plan

CI 動作には無影響 (`.md` のみ)。

リポジトリ固有の規約 + ファイル種別ごとの業界 best practice をまとめた
docs/coding-conventions.md を新規作成。CLAUDE.md の冒頭から "Read before
editing" として参照させる。

問題意識: PR #51 (devcontainer に htop 追加) で apt-get install リストの
末尾に追加してしまい、ユーザーから「Docker docs の Sort multi-line args
推奨を指摘されないと適用しないのは怠慢」とフィードバック。レビューで毎回
指摘するより、リポジトリ規約として記録した方が長期コストが低い。

初版はかなり薄い (Dockerfile / CMake / GHA workflow / C++ / Shell / docs)。
新しい知見が出たら追記する運用とする旨も明記。
@thawk105
thawk105 merged commit 42dfded into master May 13, 2026
2 checks passed
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