setup-coding-standards について
提供されたベースラインとコードで確認した規約をもとに、リポジトリのコーディング規約文書を作成するスキルです。既存ファイルを先に確認し、ベースラインの構成を保ち、書き込み後に内容を検証します。
主な機能
- 01リポジトリのルートを特定
- 02既存の規約ファイルを確認
- 03提供されたベースラインをそのまま転記
- 04コードで検証した規約のみ追記
- 05文書を読み戻して検証
活用シーン
- 01リポジトリのコーディング規約を作成
- 02ソースコードで確認した規約を記録
- 03既存の規約ファイルとの重複を回避
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ hu3rror/ my-skills --skill setup-coding-standardsインストール後、Claude Code で/setup-coding-standardsを入力して読み込まれたか確認します。
同梱ファイルreferences/baseline.md
詳細
リポジトリのコーディング規約を初期化する
手順
-
リポジトリのルートを特定します。 作業ディレクトリで
git rev-parse --show-toplevelを実行します。リポジトリに Git ルートがない場合は、作業ディレクトリを使用します。ルートパスを 1 つ選べば完了です。 -
既存の規約ファイルを確認します。 ルートに
CODING_STANDARDS.mdと類似ファイル(coding-standards.md、大文字・小文字の違いがあるファイル名)がないか確認します。存在する場合は、そこで終了し、そのパスを報告します。何も書き込みません。存在の有無を判断すれば完了です。 -
ファイルを作成します。 このスキルのディレクトリにある
references/baseline.mdを読み、その内容をファイルの先頭として一字一句そのままコピーします。見出しの名前や構成は変更しないでください。ベースラインの末尾にはマーカーコメントがあります。リポジトリの規約はそのマーカーより下に記載し、上には記載しません。続けて、現在のコードから確認したリポジトリの規約を追記します。根拠を明記し、推測で書かないでください。空の見出しは作成しません。コメントは根拠になりません。コメントに記載された規約は、対象のコードで確認するか、記載を見送ってください。リポジトリのツールがすでに強制している規約を単に言い換えるものは省略してください。フォーマッター、リンター、型チェッカーを、それぞれの規約の唯一の情報源とします。確認済みの規約がない場合、ファイルにはベースラインのみを記載します。ベースライン部分がreferences/baseline.mdと完全に一致し、追記した行がすべてマーカーの下にあり、コードで確認済みで、空のセクションがないことを確認すれば完了です。 -
書き込みます。 ファイルをリポジトリのルートに書き込みます。書き込んだ内容を読み戻し、作成した内容と一致していることを確認します。ファイルが存在し、内容が一致すれば完了です。
-
報告します。 パス、書き込んだ内容(ベースラインのみ、またはベースラインと追記した規約の一覧)、およびファイルの拡張は 1 か所だけを編集すればよいことを報告します。新しい規則はここに追加し、それぞれの規則の記載場所を 1 か所に保ちます。