mcpField
C
core-coding-standards

core-coding-standards

github.com/ravnhq開発16100 回インストール21 週間前に更新
リポジトリ

core-coding-standards について

core-coding-standards は、シンプルさ、明確な責務、明示的なエラー処理などの実践的なコーディング原則を扱うスキルです。エージェントによるコードレビューや変更を具体的に導き、早すぎる抽象化や最適化を避けます。

主な機能

  1. 01シンプルで責務が明確なコード
  2. 02意図が伝わる命名
  3. 03重複と抽象化の抑制
  4. 04明示的なエラー処理
  5. 05指針を適用するワークフロー

活用シーン

  1. 01サービス内の不要な重複の確認
  2. 02動作を保ったリファクタリング
  3. 03タスクへの一貫したコーディング原則の適用

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/ravnhq/ai-toolkit --skill core-coding-standards

インストール後、Claude Code で/core-coding-standardsを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

rules/
_sections.md
comment-why-not-what.md
org-no-premature-abstraction.md

詳細

原則

  • シンプルに保つ(KISS)— 動作する最もシンプルな解決策を優先します
  • 繰り返しを避ける(DRY)— 重複が3つ見つかったら抽出します。それより前には行いません
  • 単一責任 — 各モジュール/関数は1つのことだけを行います
  • 意図が伝わる説明的な名前を使います
  • ファイルとフォルダーにはケバブケースを使います
  • 関数の入出力を明確にし、副作用を最小限に抑えます
  • 関数の規模を適切に保ちます — ロジックの説明にコメントが必要になったら抽出します
  • 使用されていないコードは削除します — コメントアウトして残しません
  • エラーを決して黙って無視しません
  • 最適化の前に計測します — 時期尚早なパフォーマンス改善は行いません
  • 時期尚早な抽象化は避けます — 抽出するのは、具体的な重複が3つできてからにします

ルール

具体的なパターンについては、ルールの索引を参照してください。

例

トリガーする例

ユーザー:「このサービスをレビューし、動作を変えずに重複を取り除いてください。」

期待される動作:core-coding-standards のガイダンスを使用し、そのワークフローに従って、実行可能なアクションを含む出力を返します。

トリガーしない例

ユーザー:「一度限りの商品マーケティング用のキャッチコピーを作成してください。」

期待される動作:core-coding-standards を優先せず、より適切なスキルを選ぶか、スキルを使わずに対応します。

トラブルシューティング

スキルがトリガーされない
  • エラー:期待される場面でスキルが選択されません。
  • 原因:依頼の文面が、説明に記載されたトリガー条件に明確に一致していません。
  • 解決策:説明にある分野やタスクのキーワードを明示して言い換え、再試行します。
ガイダンスが別のスキルと競合する
  • エラー:1つのタスクで複数のスキルの指示が競合しています。
  • 原因:読み込まれたスキルの対象範囲が重複しています。
  • 解決策:現在のステップでどのスキルを優先するかを明示し、まずそのワークフローを適用します。
出力が一般的すぎる
  • エラー:結果に具体的で実行可能な詳細がありません。
  • 原因:タスクの入力に、コンテキスト、制約、または出力形式が不足しています。
  • 解決策:具体的な制約(環境、対象範囲、形式、成功基準)を追加して再実行します。

ワークフロー

  1. 依頼が core-coding-standards の対象範囲とトリガー条件に明確に一致するかを確認します。
  2. スキルのルールと参照先のガイダンスを適用して、具体的な結果を作成します。
  3. 制約に照らして出力の品質を検証し、不足があれば明示的な前提を示して一度だけ改善します。

コメント