docs: コーディング規約集 docs/coding-conventions.md を新設して CLAUDE.md から参照 - #52
Merged
Conversation
リポジトリ固有の規約 + ファイル種別ごとの業界 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)。 新しい知見が出たら追記する運用とする旨も明記。
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
リポジトリ固有のコーディング規約と、ファイル種別ごとに 指摘される前に 適用すべき業界 best practice を 1 か所にまとめる。CLAUDE.md からは "Read before editing" として参照。
動機
#51 で devcontainer に `htop` を追加した際、`apt-get install` リストの末尾に追加してしまい、ユーザーから「Docker docs の Sort multi-line arguments は周知の best practice。指摘されないと適用しないのは怠慢」とフィードバック。
レビューで毎回指摘するより、リポジトリ規約としてドキュメント化 した方が:
構成
`docs/coding-conventions.md` (新規) — ファイル種別ごとの規約集:
`CLAUDE.md` 冒頭に "Read before editing" 節を追加して docs を必読指定。
このドキュメント自体のルール
Test plan
CI 動作には無影響 (`.md` のみ)。