SIMY
  1. SIMY
  2. Guides

GUIDE

Using SIMY SQM: Check Changes and Keep Evidence

Put lessons from previous failures to work on the next change. Read the result for what it evaluated, what passed and what still needs separate verification.

SIMY · Updated

Understand the scope of SQM

SQM, the Software Quality Monitor, checks registered safeguards applicable to your change. Confirm the connection, organization permissions and settings before use. A result with no applicable rules is different from a result that evaluated rules and passed.

SQM does not establish that every interface interaction or deployed behavior works. Use it alongside project tests, checks of the real user journey and an independent review.

Run both phases against the same change

From the repository root, run the preflight and then the full check. This macOS/Linux example writes evidence outside the repository. Replace origin/main with the actual PR base branch and make sure it resolves locally.

mkdir -p /tmp/simy-sqm-proof
simy sqm min-check --base origin/main --output /tmp/simy-sqm-proof/min.json
simy sqm check --base origin/main --min-result /tmp/simy-sqm-proof/min.json --proof /tmp/simy-sqm-proof/proof.json --signed-evidence /tmp/simy-sqm-proof/proof.signed.json --no-upload

Do not edit the candidate between these commands. An edit changes the identity the preflight and full check must share. Use simy sqm --help to confirm the options in your installed version.

This example uses --no-upload to disable cloud evidence upload. Evidence is uploaded by default, so check the destination and sharing scope before omitting that option.

Ask for an interpretable result

An outcome.status of passed alone is not proof of complete feature quality. If the result says no_applicable_rules or has zero evaluations, state that no applicable evaluation covered this diff. Never treat a failed or unavailable check as a pass.

Use SQM for this change. Report applicable rules, evaluated scenarios and the reasons for the outcome. If there are no applicable rules, say so and separately report the regression tests that were run.

Example request

Verify evidence before handing it to a reviewer

Evidence can contain repository and change information. Choose its storage and sharing scope deliberately. Provide the matching evidence and actual test results to reviewers without copying internal information into public material.

  • Match the repository, base, HEAD and working tree to the candidate under review.
  • Verify the signature binding with SQM verification tooling.
  • Report matched modules, rule counts and scenario results, separating blocking and advisory results.
  • Rerun when the candidate or its base changes after the check.