Skip to content

Add a non-normative hardware-contract TOML example for owner review - #26

Merged
swgiacomelli merged 3 commits into
mainfrom
docs/hardware-contract-toml-review-states
Aug 14, 2026
Merged

Add a non-normative hardware-contract TOML example for owner review#26
swgiacomelli merged 3 commits into
mainfrom
docs/hardware-contract-toml-review-states

Conversation

@swgiacomelli

Copy link
Copy Markdown
Contributor

Summary

  • Non-normative guidance only. This does not change Repository Standards, does not define an organization-wide schema, and does not require existing Markdown hardware contracts to migrate.
  • Affected class: peripheral-driver repositories that already keep interpreted device or analog-front-end claims and need predictable owner-review state.
  • Why: GitHub-flavored markdown [ ] cannot mean both "not yet reviewed" and "reviewed, sources silent," and an unchecked repository-owned decision looks non-binding even when the README has named it.
  • What: add docs/peripheral-driver-resources/HARDWARE_CONTRACT.toml.example (synthetic EX1234 placeholders) and document the declared / provisional / confirmed / omission vocabulary in the existing source-registry resource pack and documentation guide, the same optional-adoption pattern as SOURCES.toml.example.
  • Supporting experience: ph-temt6000-als Add portable device behavioral model skill #17 needed a binding named reference AFE while vendor-source rows stayed provisional; markdown checkboxes could not express that split.

Test plan

  • Confirm the change is identified as non-normative in the PR, changelog, and resource-pack status line.
  • Confirm no Repository Standards / auditor policy edits.
  • HARDWARE_CONTRACT.toml.example parses as TOML and retains synthetic placeholders.
  • Relative links from the documentation guide and resource-pack README resolve.

Made with Cursor

swgiacomelli and others added 2 commits August 14, 2026 16:20
Co-authored-by: Cursor <cursoragent@cursor.com>
…t example.

Co-authored-by: Cursor <cursoragent@cursor.com>
@swgiacomelli
swgiacomelli marked this pull request as ready for review August 14, 2026 20:28

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 532e6c207a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread docs/peripheral-driver-resources/README.md Outdated
Comment thread docs/peripheral-driver-resources/HARDWARE_CONTRACT.toml.example Outdated

Copy link
Copy Markdown
Contributor Author

Addressed the review findings in commit fe442fc:

  • Replaced the duplicated top-level default identity with default_identity_row, so one declared row value is canonical.
  • Defined the permitted review / provenance relationships and required every vendor-source row to resolve a stable source ID through either docs/SOURCES.toml or an inline [[source]] record.
  • Scoped omission to its recorded source and search_scope; broader silence now requires one row per reviewed source or an explicitly documented local multi-source form.
  • Expanded the adoption checks to cover unique IDs, default-row resolution, source resolution, reproducible evidence, and scoped omissions.
  • Removed the stale example.invalid sentinel wording and updated the changelog.

Validation completed: the example parses as TOML, all five example rows satisfy the documented source/state invariants, relative links resolve, git diff --check passes, and all 21 repository tests pass.

@swgiacomelli
swgiacomelli merged commit 060a3c2 into main Aug 14, 2026
@swgiacomelli
swgiacomelli deleted the docs/hardware-contract-toml-review-states branch August 14, 2026 20:43
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