quality.md 0.3.1 → 0.4.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/README.md +37 -0
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -35,6 +35,22 @@ npm install quality.md -g
|
|
|
35
35
|
|
|
36
36
|
## Usage
|
|
37
37
|
|
|
38
|
+
Create and check a first model with the CLI:
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
qualitymd init
|
|
42
|
+
qualitymd lint
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Expected first result:
|
|
46
|
+
|
|
47
|
+
```text
|
|
48
|
+
Created QUALITY.md
|
|
49
|
+
|
|
50
|
+
Next: qualitymd lint QUALITY.md
|
|
51
|
+
QUALITY.md is valid.
|
|
52
|
+
```
|
|
53
|
+
|
|
38
54
|
Invoke the `/quality` skill to manage quality for your project:
|
|
39
55
|
|
|
40
56
|
```text
|
|
@@ -120,6 +136,27 @@ It does not cover billing system behavior or product incident response.
|
|
|
120
136
|
An agent that reads this file can evaluate support work against the stated
|
|
121
137
|
requirements, produce findings, and rate the results against the model's scale.
|
|
122
138
|
|
|
139
|
+
For a completed evaluation run, the CLI renders a concise summary and the full
|
|
140
|
+
report from records supplied by the `/quality` skill:
|
|
141
|
+
|
|
142
|
+
```text
|
|
143
|
+
Wrote quality/evaluations/0001-subject-quality-eval/report-summary.md, quality/evaluations/0001-subject-quality-eval/report.md, and quality/evaluations/0001-subject-quality-eval/report.json
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
A summary excerpt looks like this:
|
|
147
|
+
|
|
148
|
+
```md
|
|
149
|
+
# Quality Evaluation Summary
|
|
150
|
+
|
|
151
|
+
| Field | Value |
|
|
152
|
+
| -------------- | ------ |
|
|
153
|
+
| Overall rating | Target |
|
|
154
|
+
|
|
155
|
+
## Top Issues
|
|
156
|
+
|
|
157
|
+
None recorded.
|
|
158
|
+
```
|
|
159
|
+
|
|
123
160
|
## The Specification
|
|
124
161
|
|
|
125
162
|
The full format specification lives at [`SPECIFICATION.md`](SPECIFICATION.md).
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "quality.md",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.1",
|
|
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.4.1",
|
|
38
|
+
"@qualitymd/cli-darwin-x64": "0.4.1",
|
|
39
|
+
"@qualitymd/cli-linux-arm64": "0.4.1",
|
|
40
|
+
"@qualitymd/cli-linux-x64": "0.4.1",
|
|
41
|
+
"@qualitymd/cli-win32-arm64": "0.4.1",
|
|
42
|
+
"@qualitymd/cli-win32-x64": "0.4.1"
|
|
43
43
|
},
|
|
44
44
|
"publishConfig": {
|
|
45
45
|
"access": "public"
|