house-rules について
コードベースへの貢献者向けに、テスト、情報源、ドメイン用語、時刻依存テストのルールを定めるスキルです。コードと関連文書には writing-lean の使用を求めます。
主な機能
- 01writing-lean の使用
- 02プロジェクトの動作をテスト
- 03定義済みの情報源を使用
- 04用語集の語彙に準拠
- 05テストで時刻を固定
活用シーン
- 01コードと説明文の作成
- 02プロジェクト独自の動作のテスト
- 03共有定数やパッケージ型の参照
- 04時刻依存テストの作成
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ clhbid/ agent-context --skill house-rulesインストール後、Claude Code で/house-rulesを入力して読み込まれたか確認します。
詳細
開発ルール
コードと、それを説明するすべての内容は、writing-lean スキルを使って記述します。
- 依存関係ではなく、私たちのコードをテストします。 私たちのコードが追加する動作をテストし、パッケージは所与のものとして扱います。その値はテーブルをコピーせずにインポートし、動作のテストはパッケージ自体に任せます。
- 信頼できる情報源は一つにします。 各値は定義されている場所から取得します。Tailwind のスケール(
max-w-[1468px]ではなくmax-w-7xl)、共有定数、またはパッケージ独自の型を使います。 - 用語集のドメイン用語を使います。 clhbid/CLHbid-LiveAuction の
GLOSSARY.mdは、アプリにおける唯一の信頼できる情報源です。domain-modelingスキルを使って読み、そこにある用語を使います。Avoid と記された用語は使わず、用語が不足している場合は新しい用語を作らずに、用語集への追加を提案します。 - 仕様の書き方。 テストフレームワークのフックでセットアップと後処理を行います。準備、実行、検証の順に進め、結果全体を検証して、項目が一つでも余分にあればテストが失敗するようにします。
- 仕様が時刻に依存する場合は、常に時計を偽装します。 これにより、どの時刻やタイムゾーンでもテストが成功します。
コメント
Markdown 対応