Skip to content

[go-CAN-08] README never mentions RELAY despite being the primary RELAY-conformant entry point #80

Description

@SoundMatt

Location: README.md (zero occurrences of "RELAY" in the entire file)

Finding: go-CAN imports the RELAY module, re-exports SpecVersion, ships an Adapt() relay.Node bridge plus ToMessage/FromMessage conversion, and a cmd/cantool CLI implementing the RELAY-mandated version/capabilities/status commands — yet none of this is mentioned in the README. There's no conformance statement, no declared spec version, no example of using Adapt() to cross into other RELAY protocols, and no note that cantool is the conformance binary. Every other conformance-facing document in the repo (THREAT_MODEL, the CLI's own help text, source comments) references RELAY; the README, which is the first thing most readers open, does not.

Recommendation: Add a "RELAY conformance" section to the README stating the declared spec version, documenting Adapt()/the message-envelope surface with an example, and listing the mandatory CLI commands.

Filed from the 2026-07-29 ecosystem audit register; independently re-verified against current HEAD before filing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation improvementssev:mediumMedium severity

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions