docs: record complete rule coverage and the corpus reaching 21 - #172
Merged
Conversation
#169 and #170 landed together, so every detection rule now has a scenario exercising it, which is the invariant #140 put in CONTRIBUTING. Verified by iterating the registry rather than by reading: 16 of 16 codes appear in some scenario's expectedFailures. The corpus is at 21, which clears the 20+ scenario exit criterion in the v1.0 milestone. Records that, and updates the station ID allocation, where 020 and 021 have now shipped and the next free number is 022. Also records why #170 needed its branch repaired, since the failure mode is easy to repeat: cut before #161, the conflict resolution deleted heartbeat-timeout.ts and left three stray markers that broke typecheck and build. The scenario itself was fine.
sepehr-safari
added
type:docs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
#169 and #170 landed together, so this folds both forward.
The milestone worth naming
Rule coverage is complete. All 16 detection rules now have a scenario
exercising them, which is the invariant #140 wrote into
CONTRIBUTING.md. Verifiedby iterating the registry rather than by reading: 16 of 16 codes appear in some
scenario's
expectedFailures.The corpus is at 21, which clears the 20+ scenario exit criterion in the v1.0
milestone (
ROADMAP.mdline 157). The remaining v1.0 work is API stabilization,the docs overhaul and release hardening.
Also recorded
good-first-issuecompletions: Add a new scenario: meter-value-zero #108 byYANGCHUNHONG3000(their third) and Add a new scenario: repeated-boot-notification #139 by
MayurK-cmd(their second), both delivered within twodays of assignment.
cut before feat(scenarios): add heartbeat-timeout scenario for TIMEOUT_NO_HEARTBEAT #161, its conflict resolution deleted
heartbeat-timeout.ts(whichwould have reverted feat(scenarios): add heartbeat-timeout scenario for TIMEOUT_NO_HEARTBEAT #161) and left three stray
>characters that broketypecheckandbuild. The scenario file and changeset were fine.020and021have shipped, 004 through 021 are all inuse, and the next free number is 022. Notes that moving Add a new scenario: meter-value-zero #108 to
021alsorequired renumbering its
idTagandtransactionId, which the issue stillcarried from before the move.
Verification
Confirmed the edits did not disturb the automation that parses this file: the
script still no-ops without duplicating a log entry and its 9 unit tests pass.
pnpm format:checkpasses. Registry length, ROADMAP line, PR states and everystation ID owner were read off the tree and GitHub rather than from memory.
Documentation only, no changeset.