quality.md 0.2.2 → 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 +16 -5
- package/bin/qualitymd.js +2 -1
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -66,9 +66,11 @@ ratingScale:
|
|
|
66
66
|
criterion: "Falls below the minimum acceptable bar."
|
|
67
67
|
targets:
|
|
68
68
|
triage:
|
|
69
|
+
title: Triage
|
|
69
70
|
source: ./support
|
|
70
71
|
factors:
|
|
71
72
|
responsiveness:
|
|
73
|
+
title: Responsiveness
|
|
72
74
|
description: Customers receive timely, useful attention.
|
|
73
75
|
requirements:
|
|
74
76
|
"urgent messages are visible":
|
|
@@ -76,6 +78,7 @@ targets:
|
|
|
76
78
|
New messages are classified so urgent customer-impacting issues
|
|
77
79
|
are separated from routine requests.
|
|
78
80
|
accuracy:
|
|
81
|
+
title: Accuracy
|
|
79
82
|
description: Replies are correct, complete, and grounded in policy.
|
|
80
83
|
requirements:
|
|
81
84
|
"answers cite the current policy":
|
|
@@ -122,16 +125,17 @@ but it is where the model explains itself.
|
|
|
122
125
|
The root model is a target plus a model-wide `ratingScale`.
|
|
123
126
|
|
|
124
127
|
```yaml
|
|
125
|
-
title: <string> #
|
|
128
|
+
title: <string> # Required
|
|
126
129
|
description: <string> # Optional
|
|
127
130
|
ratingScale: # Required, ordered best to worst
|
|
128
131
|
- level: <level-name> # Required, unique within the scale
|
|
129
|
-
title: <string> #
|
|
132
|
+
title: <string> # Required
|
|
130
133
|
description: <string> # Recommended
|
|
131
134
|
criterion: <string> # Required
|
|
132
135
|
source: <string> # Optional
|
|
133
136
|
factors: # Optional*
|
|
134
137
|
<factor-name>:
|
|
138
|
+
title: <string> # Required
|
|
135
139
|
description: <string> # Recommended
|
|
136
140
|
factors: # Optional
|
|
137
141
|
<sub-factor-name>: <Factor>
|
|
@@ -178,7 +182,7 @@ assessment -> findings -> rating result
|
|
|
178
182
|
## The CLI
|
|
179
183
|
|
|
180
184
|
> **The CLI is an early work in progress.** Today the binary ships
|
|
181
|
-
> `qualitymd init`, `qualitymd lint`, `qualitymd spec`, and the
|
|
185
|
+
> `qualitymd init`, `qualitymd lint`, `qualitymd spec`, `qualitymd status`, and the
|
|
182
186
|
> `qualitymd evaluation` run-record surface.
|
|
183
187
|
|
|
184
188
|
`qualitymd` draws one hard line: the **CLI is deterministic and never calls a
|
|
@@ -193,6 +197,12 @@ The deterministic surface:
|
|
|
193
197
|
- **`qualitymd lint`** — validate a file's structure, fast and deterministic,
|
|
194
198
|
exiting non-zero on errors so it drops into CI.
|
|
195
199
|
- **`qualitymd spec`** — emit the bundled `QUALITY.md` format specification.
|
|
200
|
+
- **`qualitymd status`** — emit a deterministic project-state snapshot for
|
|
201
|
+
routing, automation, and agent use.
|
|
202
|
+
- **`qualitymd version`** — show structured CLI and bundled specification
|
|
203
|
+
version metadata.
|
|
204
|
+
- **`qualitymd upgrade --check`** — explicitly check the current install method,
|
|
205
|
+
latest version, and recommended upgrade action.
|
|
196
206
|
- **`qualitymd evaluation create-run`** — create and number an evaluation run
|
|
197
207
|
folder.
|
|
198
208
|
- **`qualitymd evaluation add-record`** — write assessment, analysis, and
|
|
@@ -201,8 +211,9 @@ The deterministic surface:
|
|
|
201
211
|
assessment and analysis coverage for resume diagnostics.
|
|
202
212
|
- **`qualitymd evaluation show-status`** — inspect whether a run is ready to
|
|
203
213
|
render.
|
|
204
|
-
- **`qualitymd evaluation build-report`** — derive `report.md
|
|
205
|
-
and optionally gate with
|
|
214
|
+
- **`qualitymd evaluation build-report`** — derive `report-summary.md`,
|
|
215
|
+
`report.md`, and `report.json`, and optionally gate with
|
|
216
|
+
`--fail-at-or-below`.
|
|
206
217
|
|
|
207
218
|
## Conceptual model
|
|
208
219
|
|
package/bin/qualitymd.js
CHANGED
|
@@ -24,7 +24,8 @@ try {
|
|
|
24
24
|
process.exit(1);
|
|
25
25
|
}
|
|
26
26
|
|
|
27
|
-
const
|
|
27
|
+
const env = { ...process.env, QUALITYMD_INSTALL_METHOD: "npm" };
|
|
28
|
+
const result = spawnSync(binary, process.argv.slice(2), { stdio: "inherit", env });
|
|
28
29
|
|
|
29
30
|
if (result.error) {
|
|
30
31
|
throw result.error;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "quality.md",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"description": "Companion CLI for the QUALITY.md file format and /quality agent skill, used to evaluate and improve AI assistant projects and harnesses.",
|
|
5
5
|
"homepage": "https://getquality.md",
|
|
6
6
|
"keywords": [
|
|
@@ -34,12 +34,12 @@
|
|
|
34
34
|
"bin"
|
|
35
35
|
],
|
|
36
36
|
"optionalDependencies": {
|
|
37
|
-
"@qualitymd/cli-darwin-arm64": "0.
|
|
38
|
-
"@qualitymd/cli-darwin-x64": "0.
|
|
39
|
-
"@qualitymd/cli-linux-arm64": "0.
|
|
40
|
-
"@qualitymd/cli-linux-x64": "0.
|
|
41
|
-
"@qualitymd/cli-win32-arm64": "0.
|
|
42
|
-
"@qualitymd/cli-win32-x64": "0.
|
|
37
|
+
"@qualitymd/cli-darwin-arm64": "0.3.0",
|
|
38
|
+
"@qualitymd/cli-darwin-x64": "0.3.0",
|
|
39
|
+
"@qualitymd/cli-linux-arm64": "0.3.0",
|
|
40
|
+
"@qualitymd/cli-linux-x64": "0.3.0",
|
|
41
|
+
"@qualitymd/cli-win32-arm64": "0.3.0",
|
|
42
|
+
"@qualitymd/cli-win32-x64": "0.3.0"
|
|
43
43
|
},
|
|
44
44
|
"publishConfig": {
|
|
45
45
|
"access": "public"
|