Skip to content

docs(skills): firmware skill carries the 2026-10-27 audit rules - #400

Merged
mottihoresh merged 1 commit into
mainfrom
docs/firmware-skill-audit-rules
Oct 27, 2026
Merged

mottihoresh merged 1 commit into
mainfrom
docs/firmware-skill-audit-rules

Conversation

@mottihoresh

Copy link
Copy Markdown
Collaborator

The audit of the last day's firmware and client PRs found the same gaps over and over. This PR writes the rules that prevent them into .claude/skills/firmware/SKILL.md, so every session that loads the skill gets them.

Rules added or changed

  • Spec sync by behaviour, not only by value. Grep the old behaviour's wording as well ("coalesc", "broadcast", "once per boot", renamed listeners) across FirmwarePlan, TechSpec, docs/, READMEs and docblocks. Update every TechSpec that describes the behaviour. Amend or supersede every 00-decisions.md entry the change overrides. fix(firmware)!: sim output reaches CAN, inputs win the bus and are never lost silently (#389) #392 left D7/D24 describing removed coalescing, and fix(firmware): sync nodes one at a time so SYNC_REQ answers can't overflow the bridge (#387) #390 left D5 describing a broadcast SYNC_REQ.
  • Pages that go stale fastest: compatibility.md, guides/bring-up.md, guides/new-control-type.md, build-flags.md and FirmwarePlan 09 join index.md, control-types.md and can-bus.md.
  • Closing a ticket: tick every Done-when box with its evidence, or move the unmet item to a named follow-up, for every ticket a PR closes. Say when a check was substituted or not re-run.
  • Release facts come from the tag: git merge-base --is-ancestor <commit> firmware-vX. firmware-v0.2.0 was cut 7 minutes before feat(firmware)!: v1.0 freeze fixes — firmware version on the bus, config structs, pinned dependencies (#295) #359. Releases before 1.0.0 are test-only.
  • No new reporting without a need: no new frames, fields, flag bits or DIAG growth for visibility's sake. Loss counters stay on the board. "Never lost silently" means counted on the board.
  • Responsive inputs first: input loss or latency fails; a late or once-dropped output that catches up is acceptable (D31).

Skill text only. check_doc_refs.py: OK.

Spec sync greps the old behaviour's wording, not only values, updates every
TechSpec that describes it and amends every decision it overrides; more
stale-fast pages; tick or hand off every Done-when box before a ticket
closes; release facts come from the tag; no new reporting without a need;
responsive inputs first.
@mottihoresh
mottihoresh merged commit e7b7ad5 into main Oct 27, 2026
8 checks passed
@mottihoresh
mottihoresh deleted the docs/firmware-skill-audit-rules branch October 27, 2026 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant