Check your work before you commit¶

TL;DR

Run qmstrace check after every change, work through its list — violations first, then gaps — and run qmstrace check --strict before you commit. When it exits 0, the repo's trace data is right and complete as far as this repo can tell.

Steps¶

See where you are.
```
qmstrace status
```
What was read, and one line per requirement. If an item you wrote is missing, it is in a file its type is not read from — check will say so.
List what is wrong and what is missing.
```
qmstrace check
```
Each line ends with Fix: — the next move. Work through the violations first: a gap often exists only because a violation refused the link it needs.
Fix a violation by correcting the line it names. Never invent an ID to make one go away: when nothing real fits — no clause covers a requirement, no change request exists — stop and ask whoever owns the decision.
Close a gap by doing the work it names — write the design element, the test — and then the link. A link states a fact: tag a test with a requirement only if the test fails when the requirement is broken. To be sure, break the code on purpose and watch the tagged test fail.
Run the gate.
```
qmstrace check --strict
```
0 — commit. 1 — the result line says whether violations or gaps remain.

When a gap cannot be closed here¶

A rule may ask for an item type this repo does not declare — a repo with no design documents, say. qmstrace rules marks such a rule cannot be met with the item types this repo scans. The gap stands until the repo declares that type, or the item is met in another repo of the project — judged by qmstrace ledger check, run in the ledger. Under --strict it fails, on purpose: the project's rules say so, and no exemption is hidden. Where the ledger holds the requirements and the design, every requirement's tests are in another repo: there the gate is qmstrace ledger check --strict.

In a pipeline¶

A pipeline checks out the product repo alone, so the repo must carry the project's trace schema itself — a generated, verified copy, made in the ledger by qmstrace ledger copy-schema. See share the project's schema. The agreement and change requests are then reported as not verified; they are judged at the ledger's import.