qfai 1.0.4 → 1.0.5

package/assets/init/.qfai/contracts/db/README.md

@@ -0,0 +1,8 @@
+# contracts/db/
+
+Place DB contracts here (YAML).
+
+Guidelines:
+
+- Keep contracts minimal: define only what scenarios/tests need to validate.
+- Include examples where helpful.

package/assets/init/.qfai/contracts/ui/README.md

@@ -0,0 +1,8 @@
+# contracts/ui/
+
+Place UI contracts here (YAML).
+
+Guidelines:
+
+- Keep contracts minimal: define only what scenarios/tests need to validate.
+- Include examples where helpful.

package/assets/init/.qfai/report/README.md

@@ -0,0 +1,13 @@
+# report/
+
+This directory is reserved for generated outputs.
+
+Examples:
+
+- `qfai report` output
+- generated traceability reports
+- diagnostic artifacts you choose to store
+
+Recommended:
+
+- commit policy is project-dependent (often: do NOT commit large generated files)

package/assets/init/.qfai/require/README.md

@@ -1,28 +1,6 @@
-# .qfai/require/
+# require/
 
-既存の要件定義書や外部資料を集約するためのディレクトリです。
-QFAI は `.qfai/require/` を **入力（上流）** として扱い、ここに置かれた内容を根拠に Spec を作成します。
+This folder contains the Requirements SSOT.
 
-## 置き方（例）
-
-- `.qfai/require/req-0001-<slug>.md`
-- `.qfai/require/links.md`（外部ドキュメントへのリンク集）
-- `.qfai/require/raw/`（PDFや画像などの原本）
-
-> 形式は限定しません。内容が参照可能であることを優先してください。
-
-## 参照ルール（重要）
-
-- `.qfai/require/` は **上流のSSOT** です。
-- `.qfai/specs` や `contracts` は **.qfai/require を参照してよい**。
-- `.qfai/require` 側から `.qfai/specs` や `contracts` を参照するのは **禁止**（循環参照防止）。
-
-## AI プロンプトの利用
-
-- `.qfai/prompts/require-to-spec.md` を使用し、要件から Spec を作成します。
-- 生成後は必ず人間がレビューし、Spec/Scenario/Contracts の整合を確認してください。
-
-## 注意
-
-- `.qfai/require/` の内容は QFAI の validate 対象外です。
-- 機密情報の取り扱いは各プロジェクトのルールに従ってください。
+- `require.md` is the single-file requirements artifact.
+- Keep requirements **testable** (EARS) and avoid implementation detail.

package/assets/init/.qfai/require/require.md

@@ -0,0 +1,74 @@
+# Requirements
+
+> Fill this in using `/qfai-require`.
+
+## 1. Overview
+
+- Problem / opportunity:
+- Target users:
+- Success definition:
+
+## 2. Scope
+
+### In scope
+
+-
+
+### Out of scope
+
+-
+
+## 3. Constraints & Assumptions
+
+### Constraints
+
+-
+
+### Assumptions
+
+-
+
+## 4. Glossary
+
+-
+
+## 5. Functional Requirements (EARS)
+
+### REQ-FUNC-001: <title>
+
+- Statement (EARS):
+- Rationale:
+- Acceptance criteria:
+- Notes / edge cases:
+
+## 6. Non‑Functional Requirements
+
+### Security
+
+-
+
+### Performance
+
+-
+
+### Reliability / Availability
+
+-
+
+### Observability
+
+-
+
+## 7. Acceptance Criteria (summary)
+
+-
+
+## 8. Open Questions
+
+### Blocking
+
+-
+
+### Non‑blocking
+
+-

package/assets/init/.qfai/specs/README.md

@@ -1,59 +1,9 @@
-# Specs (Spec Pack)
+# specs/
 
-このディレクトリは「Spec / Delta / Scenario」を **1セット（Spec Pack）** として管理するための入口です。
+A **spec pack** lives under `specs/spec-XXXX/` and contains:
 
-## 置くべきファイル
+- `spec.md` : SDD spec (source of truth for behavior)
+- `delta.md` : impact / migration / verification plan
+- `scenario.feature` : Gherkin scenarios (ATDD skeleton)
 
-- `spec-0001/spec.md`（必須）
-- `spec-0001/delta.md`（必須）
-- `spec-0001/scenario.feature`（必須・Gherkin）
-
-> `spec-0001` は **4桁連番**。Spec ID も **4桁（SPEC-0001）** です。
-
-## Spec（spec.md）最小例
-
-```md
-# SPEC-0001: 注文登録の最小要件
-
-QFAI-CONTRACT-REF: UI-0001, API-0001, DB-0001, THEMA-001
-
-## 背景
-
-- 例: 受注の登録ルールを明文化し、手戻りを減らすため
-
-## 業務ルール
-
-- [BR-0001][P2] 受注は承認者が承認するまで確定しない
-```
-
-### BR の書き方
-
-- **1ルール = 1 BR** を守る
-- Priority は **P0/P1/P2/P3** のいずれかを必ず付与
-- BR 定義は **`## 業務ルール` セクション内のみ**（他セクションは参照扱い）
-
-### Contract 参照の書き方
-
-- `QFAI-CONTRACT-REF:` 行で契約IDを宣言する（複数行可）
-- 参照不要な場合は `QFAI-CONTRACT-REF: none`
-
-## Delta（delta.md）
-
-- 変更の要約・根拠・影響範囲・受入観点を明記する
-
-## Scenario（scenario.feature）最小要件
-
-- **Gherkin 記法**（Given/When/Then）
-- **1ファイル = 1 Scenario**（Scenario Outline 含む）
-- `# QFAI-CONTRACT-REF: ...` をコメント行で **必須宣言**（参照なしは `none`）
-- `@SPEC-xxxx` は Feature レベルに **ちょうど1つ**必要
-- Scenario / Scenario Outline には `@SC-xxxx` が **ちょうど1つ**必要
-- Scenario / Scenario Outline には `@BR-xxxx` が **1つ以上**必要
-
-## CI でチェックされること（抜粋）
-
-- Spec: 必須セクション、SPEC/BR ID、BR Priority、ID 形式、Contract 参照の実在性、Contract 参照の必須宣言
-- Delta: delta.md の存在
-- Scenario: Feature/Scenario の存在、タグ要件、Given/When/Then、契約参照の宣言/形式
-- Traceability: BR→SC、Spec→Contract、SC→Test の接続、BR の所属 SPEC 整合
-- IDs: 定義 ID の重複検知（Spec/Scenario/Contracts）
+Create/update spec packs with `/qfai-spec`.

package/assets/init/root/.github/workflows/qfai.yml

@@ -19,4 +19,4 @@ jobs:
       - uses: actions/upload-artifact@v4
         with:
           name: qfai-validation
-          path: .qfai/out/validate.json
+          path: .qfai/report/validate.json

package/assets/init/root/qfai.config.yaml

@@ -1,8 +1,8 @@
 paths:
   specsDir: .qfai/specs
   contractsDir: .qfai/contracts
-  outDir: .qfai/out
-  promptsDir: .qfai/prompts
+  outDir: .qfai/report
+  promptsDir: .qfai/assistant/prompts
   srcDir: src
   testsDir: tests
 validation:
@@ -29,4 +29,4 @@ validation:
     orphanContractsPolicy: error
     unknownContractIdSeverity: error
 output:
-  validateJsonPath: .qfai/out/validate.json
+  validateJsonPath: .qfai/report/validate.json