qfai 0.2.8 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/assets/init/.qfai/README.md +1 -1
- package/assets/init/.qfai/contracts/api/api-0001-sample.yaml +1 -4
- package/assets/init/.qfai/prompts/README.md +1 -1
- package/assets/init/.qfai/spec/README.md +5 -3
- package/assets/init/.qfai/spec/decisions/ADR-0001.md +1 -1
- package/assets/init/.qfai/spec/decisions/README.md +2 -1
- package/assets/init/.qfai/spec/scenarios/scenarios.feature +1 -1
- package/assets/init/.qfai/spec/spec-0001-sample.md +2 -1
- package/dist/cli/index.cjs +471 -156
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.mjs +466 -151
- package/dist/cli/index.mjs.map +1 -1
- package/dist/index.cjs +460 -143
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +3 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.mjs +459 -143
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# OpenAPI contract sample (API-0001)
|
|
2
2
|
# - 必須: openapi, info, paths
|
|
3
|
-
# -
|
|
3
|
+
# - 重要: operationId に API-0001 のような ID を含める（validate が参照整合に利用）
|
|
4
4
|
openapi: 3.0.0
|
|
5
5
|
info:
|
|
6
6
|
title: QFAI Sample API
|
|
@@ -9,9 +9,6 @@ paths:
|
|
|
9
9
|
/health:
|
|
10
10
|
get:
|
|
11
11
|
operationId: API-0001
|
|
12
|
-
x-qfai-refs:
|
|
13
|
-
- BR-0001
|
|
14
|
-
- SC-0001
|
|
15
12
|
responses:
|
|
16
13
|
"200":
|
|
17
14
|
description: OK
|
|
@@ -39,8 +39,8 @@
|
|
|
39
39
|
|
|
40
40
|
## 業務ルール
|
|
41
41
|
|
|
42
|
-
- [BR-0001] 受注は承認者が承認するまで確定しない
|
|
43
|
-
- [BR-0002] 承認済みの受注のみ出荷依頼に進める
|
|
42
|
+
- [BR-0001] (P2) 受注は承認者が承認するまで確定しない
|
|
43
|
+
- [BR-0002] (P1) 承認済みの受注のみ出荷依頼に進める
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
## BR の書き方（重要）
|
|
@@ -48,17 +48,19 @@
|
|
|
48
48
|
- **1 ルール = 1 BR** を守る
|
|
49
49
|
- 小項目がある場合は **別 BR を採番**する（`BR-0001.1` は使わない）
|
|
50
50
|
- 参照は常に BR ID を使う
|
|
51
|
+
- Priority は **P0/P1/P2/P3 のいずれか** を必ず付与する（迷う場合は P2 から開始）
|
|
51
52
|
|
|
52
53
|
## Scenario の最小要件
|
|
53
54
|
|
|
54
55
|
- `@SC-xxxx` / `@SPEC-xxxx` / `@BR-xxxx` をタグで明示
|
|
56
|
+
- タグ行は **Scenario 行の直前** に置く
|
|
55
57
|
- Scenario は複数の SPEC を参照してよい（`@SPEC-xxxx` を複数記載可能）
|
|
56
58
|
- `Given / When / Then` を含める
|
|
57
59
|
- UI/API/DATA 契約に接続する（トレーサビリティのエラー回避）
|
|
58
60
|
|
|
59
61
|
## CI でチェックされること（抜粋）
|
|
60
62
|
|
|
61
|
-
- Spec:
|
|
63
|
+
- Spec: 必須セクションの有無（H2）、SPEC/BR ID の存在、BR Priority、ID 形式（`PREFIX-0001`）、Contract 参照の実在性
|
|
62
64
|
- Scenario: SC/SPEC/BR の参照、Given/When/Then の有無、参照IDの実在性
|
|
63
65
|
- Traceability: BR→SC、SC→契約（UI/API/DATA）の接続、BR の所属 SPEC 整合
|
|
64
66
|
- IDs: 定義 ID の重複検知（Spec/Scenario/Contracts）
|
|
@@ -15,7 +15,7 @@ ADR は「なぜその判断をしたか」を記録するための軽量な意
|
|
|
15
15
|
|
|
16
16
|
- Status: Proposed
|
|
17
17
|
- Context: 承認者を増やすと運用が複雑になる
|
|
18
|
-
- Decision:
|
|
18
|
+
- Decision: 現時点では1段階の承認に固定する
|
|
19
19
|
- Consequences: 多段承認が必要な場合は拡張が必要
|
|
20
20
|
- Related: BR-0001, SPEC-0001
|
|
21
21
|
```
|
|
@@ -24,6 +24,7 @@ ADR は「なぜその判断をしたか」を記録するための軽量な意
|
|
|
24
24
|
|
|
25
25
|
- ID 形式（`PREFIX-0001`。ADR を含む）
|
|
26
26
|
- 参照 ID の整合性（トレーサビリティ）
|
|
27
|
+
- 必須フィールド（Status/Context/Decision/Consequences）の有無
|
|
27
28
|
|
|
28
29
|
## 依存関係
|
|
29
30
|
|