quality.md 0.6.0 → 0.7.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 +19 -19
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -33,8 +33,8 @@ Invoke the `/quality` skill to manage quality for your project:
|
|
|
33
33
|
/quality wizard Have your AI assistant/agent help you manage quality
|
|
34
34
|
/quality evaluate Evaluate the quality of your project
|
|
35
35
|
/quality evaluate security Evaluate a specific quality factor or characteristic
|
|
36
|
-
/quality evaluate payments-api Evaluate a specific
|
|
37
|
-
/quality evaluate payments-api maintainability Evaluate
|
|
36
|
+
/quality evaluate payments-api Evaluate a specific area or project component
|
|
37
|
+
/quality evaluate payments-api maintainability Evaluate an area's specific quality
|
|
38
38
|
```
|
|
39
39
|
|
|
40
40
|
Most users should work with `QUALITY.md` through their coding agent, the
|
|
@@ -88,7 +88,7 @@ ratingScale:
|
|
|
88
88
|
title: Unacceptable
|
|
89
89
|
description: The work is below the shared quality bar.
|
|
90
90
|
criterion: "Falls below the minimum acceptable bar."
|
|
91
|
-
|
|
91
|
+
areas:
|
|
92
92
|
triage:
|
|
93
93
|
title: Triage
|
|
94
94
|
source: ./support
|
|
@@ -145,7 +145,7 @@ but it is where the model explains its purpose and context.
|
|
|
145
145
|
|
|
146
146
|
### Model Schema
|
|
147
147
|
|
|
148
|
-
The root model is
|
|
148
|
+
The root model is an area plus a model-wide `ratingScale`.
|
|
149
149
|
|
|
150
150
|
```yaml
|
|
151
151
|
title: <string> # Required
|
|
@@ -167,28 +167,28 @@ factors: # Optional*
|
|
|
167
167
|
requirements: # Optional*
|
|
168
168
|
<requirement-statement>:
|
|
169
169
|
assessment: <string> # Required, exactly one
|
|
170
|
-
factors: [<factor-name>] # Required for direct
|
|
170
|
+
factors: [<factor-name>] # Required for direct area requirements
|
|
171
171
|
ratings: # Optional per-level criteria
|
|
172
172
|
<level-name>: <criterion>
|
|
173
|
-
|
|
174
|
-
<
|
|
173
|
+
areas: # Optional*
|
|
174
|
+
<area-name>: <Area>
|
|
175
175
|
```
|
|
176
176
|
|
|
177
|
-
At least one of `factors`, `requirements`, or `
|
|
178
|
-
|
|
177
|
+
At least one of `factors`, `requirements`, or `areas` must be supplied.
|
|
178
|
+
Areas can nest recursively. `ratingScale` exists only on the root model.
|
|
179
179
|
|
|
180
180
|
### Core Concepts
|
|
181
181
|
|
|
182
|
-
| Concept | Meaning
|
|
183
|
-
| ------------ |
|
|
184
|
-
| Model | The root quality model in a QUALITY.md file.
|
|
185
|
-
|
|
|
186
|
-
| Source | The material assessed for
|
|
187
|
-
| Factor | A quality dimension that matters for
|
|
188
|
-
| Requirement | A specific quality expectation.
|
|
189
|
-
| Assessment | The means of checking a requirement against
|
|
190
|
-
| Finding | An observation produced by an assessment.
|
|
191
|
-
| Rating Scale | The ordered model-wide scale used to rate results.
|
|
182
|
+
| Concept | Meaning |
|
|
183
|
+
| ------------ | -------------------------------------------------------------- |
|
|
184
|
+
| Model | The root quality model in a QUALITY.md file. |
|
|
185
|
+
| Area | The thing being evaluated. |
|
|
186
|
+
| Source | The material assessed for an area, such as a path or selector. |
|
|
187
|
+
| Factor | A quality dimension that matters for an area. |
|
|
188
|
+
| Requirement | A specific quality expectation. |
|
|
189
|
+
| Assessment | The means of checking a requirement against an area source. |
|
|
190
|
+
| Finding | An observation produced by an assessment. |
|
|
191
|
+
| Rating Scale | The ordered model-wide scale used to rate results. |
|
|
192
192
|
|
|
193
193
|
## CLI Quick Reference
|
|
194
194
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "quality.md",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.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.7.0",
|
|
38
|
+
"@qualitymd/cli-darwin-x64": "0.7.0",
|
|
39
|
+
"@qualitymd/cli-linux-arm64": "0.7.0",
|
|
40
|
+
"@qualitymd/cli-linux-x64": "0.7.0",
|
|
41
|
+
"@qualitymd/cli-win32-arm64": "0.7.0",
|
|
42
|
+
"@qualitymd/cli-win32-x64": "0.7.0"
|
|
43
43
|
},
|
|
44
44
|
"publishConfig": {
|
|
45
45
|
"access": "public"
|