OpenSpec

概要 ​

OpenSpecをカスタマイズする際のオプション。

OpenSpecは複数のカスタマイズオプションをサポートしています。このページでは、各オプションが何を変更するか、いつ使用するかを示します。

カスタマイズできるもの ​

オプション変更内容使用するタイミング
Profilesどのワークフローがインストールされるか、およびスキル、コマンド、またはその両方としてインストールされるか追加のワークフローや作業パターンが必要な場合、または不要なワークフローを削除したい場合
プロジェクト設定すべてのワークフローの実行に注入される指示：コンテキスト、ルール、および操作ガイダンス（config.yaml）タスクに常にPlaywrightテストを含めるなど、独自の方法で変更を計画したい場合
スキーマOpenSpecが生成するもの：アーティファクト、その順序、およびテンプレート変更によって異なる計画ファイル、セクション、またはフォーマットを生成する必要がある場合

どれを使用すべきか迷っていますか？ ​

設定とスキーマは、2つのレベルのカスタマイズです。どの程度関与したいかに応じて選択してください：

  • まずプロジェクト設定から始める：より軽量で、ほとんどのプロジェクトで十分です。標準のアーティファクトを保持し、その上に独自のコンテキストとルールを追加します。
  • 追加だけでは不十分な場合はスキーマをフォークする：設定はコアワークフローの上に追加するだけです。「タスクに常にテストを含める」といったルールを追加できますが、設計ドキュメントを削除したりファイル名を変更したりすることはできません。それはスキーマの領域です。フォークすると、編集用の独自のコピーが得られます。

ここの「フォーク」は、gitリポジトリのフォークではなく、openspec schema forkコマンドを意味します。詳細はスキーマを参照してください。

flowchart LR
    a["ワークフローが自分の技術スタックと規約を理解する必要がある"] --> config
    b["タスクに常にテストを含めるなど、1つのアーティファクトに追加のルールが必要"] --> config
    c["異なるアーティファクト、ファイル名、またはドキュメント構造が必要"] --> schema
    d["組み込みの指示がチームのやり方と異なる"] --> schema
    config["プロジェクト設定<br/>(config.yaml)"]
    schema["スキーマをフォーク<br/>(openspec schema fork)"]