qfai 0.7.2 → 0.8.1

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 aganesy
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -262,4 +262,4 @@ pnpm test:assets
262
262
 
263
263
  ## ライセンス
264
264
 
265
- [MIT](https://github.com/aganesy/QFAI/blob/main/LICENSE)
265
+ [MIT](https://github.com/aganesy/QFAI/blob/main/packages/qfai/LICENSE)
@@ -2,9 +2,10 @@
2
2
 
3
3
  このディレクトリは QFAI の成果物を集約する専用領域です。`.qfai` 配下だけを見れば「何を書くか」「どこから始めるか」が分かる構成にしています。
4
4
 
5
- ## 最短成功(init → validate → report)
5
+ ## 最短成功(doctor → validate → report)
6
6
 
7
7
  ```bash
8
+ npx qfai doctor --fail-on error
8
9
  npx qfai validate --fail-on error --format github
9
10
  npx qfai report
10
11
  ```
@@ -61,6 +62,8 @@ v0.7 以降、プロンプト資産のカスタマイズは `.qfai/prompts.local
61
62
  - `.qfai/prompts/**` は QFAI 標準資産であり、更新や `qfai init` 再実行で上書きされ得ます
62
63
  - 利用者が `.qfai/prompts/**` を直接編集することは非推奨・非サポートです
63
64
  - 変更したい場合は同一相対パスで `.qfai/prompts.local/**` に置いて上書きしてください
65
+ - `qfai init` は `.qfai/prompts.local/**` を **保護**します(`--force` でも上書きしません)
66
+ - 現時点の保護対象は `prompts.local` のみです(それ以外は上書きされ得ます)
64
67
 
65
68
  例:
66
69
 
@@ -6,3 +6,37 @@
6
6
  - 仕様変更: 期待値/挙動が変わる
7
7
 
8
8
  必ず `delta.md` に区分と根拠を記録する。
9
+
10
+ ---
11
+
12
+ ## 最小ルール(迷ったらこれ)
13
+
14
+ - **既存の利用者がそのまま手順・解釈で運用できる**: Compatibility
15
+ - **既存の利用者が手順変更・解釈変更・レビュー基準変更を迫られる**: Change/Improvement
16
+
17
+ 「見た目だけ」「文章だけ」でも、運用で機械消費されている可能性がある場合は慎重に扱い、根拠を `delta.md` に残す。
18
+
19
+ ---
20
+
21
+ ## 具体例(最低10件)
22
+
23
+ | 変更内容 | 区分 | QA/レビュー観点 |
24
+ | ------------------------------------------------------------- | ------------------ | ---------------------------------------------------- |
25
+ | README の誤字修正、リンク切れ修正 | Compatibility | 誤誘導が減る。既存運用は不変。 |
26
+ | report(text/markdown)の表現改善・並び順安定化(意味は不変) | Compatibility | 人間レビューの短縮。出力の“解釈”が変わらないこと。 |
27
+ | report.json のフィールド追加/並び変更(非契約を維持) | Compatibility | 非契約を明記し続ける。機械消費ユーザーへの注意喚起。 |
28
+ | validate の文言改善(issue code/意味/失敗条件は不変) | Compatibility | 次アクションが明確になる。誤爆やノイズ増がないこと。 |
29
+ | validate で新しい issue code を追加(warning/info) | Change/Improvement | CIの表示が変わる。ノイズ/誤検知の受容可否。 |
30
+ | validate の fail 条件を変更(error→warning で落ちる等) | Change/Improvement | Hard Gate が増減する。既存CIが壊れないか。 |
31
+ | init の生成物構成を変更(新規ファイル追加) | Change/Improvement | 既存リポジトリへの導入影響。上書き/衝突/運用導線。 |
32
+ | init が既存ファイルを上書きする/保護対象を変える | Change/Improvement | 事故リスクが高い。保護の回帰テスト必須。 |
33
+ | Spec/Scenario/Contract のID規約を変更 | Change/Improvement | 既存資産が無効化され得る。移行ガイド必須。 |
34
+ | overlay の優先順位/探索規則を変更 | Change/Improvement | 既存の prompts.local 運用が壊れる。回帰テスト必須。 |
35
+
36
+ ---
37
+
38
+ ## QA/レビュー時の判断テンプレ
39
+
40
+ - **修正が必要**: Hard Gate を増やしていないか、既存の運用手順を壊していないか、保護領域(prompts.local)が破壊されないか
41
+ - **許容**: 誤誘導削減、説明の具体化、並び順の安定化などで、意味・失敗条件が変わらないもの
42
+ - **要議論**: report.json の変更、validate の新ルール追加、init生成物の変更(CI/運用への波及が読みにくいもの)
@@ -23,3 +23,8 @@ QFAI v0.7 以降は、プロンプト資産のカスタマイズ手段を **over
23
23
  - `.qfai/prompts/**` は **QFAI 標準資産**です(更新や `qfai init` の再実行で上書きされ得ます)。
24
24
  - 利用者が `.qfai/prompts/**` を直接編集することは **非推奨・非サポート(ほぼ禁止)**です。
25
25
  - 変更したい場合は、対象ファイルを `prompts.local` にコピーして上書きしてください。
26
+
27
+ ## init 再実行時の保護(契約)
28
+
29
+ - `qfai init` は `.qfai/prompts.local/**` を **保護**します(`--force` を付けても上書きしません)。
30
+ - 現時点でこの保護対象は `prompts.local` のみです。