Skip to content

docs: add scoped protocol runtime failure contracts - #11

Merged
masarray merged 2 commits into
masterfrom
chore/agent-engineering-contract-v4
Sep 10, 2026
Merged

docs: add scoped protocol runtime failure contracts#11
masarray merged 2 commits into
masterfrom
chore/agent-engineering-contract-v4

Conversation

@masarray

Copy link
Copy Markdown
Owner

Summary

Adds narrowly scoped engineering contracts beneath the existing mature root AGENTS.md; the root contract is not rewritten.

src/ARIEC60870.Master/AGENTS.md

  • explicit master/session state authority
  • root-cause-first loop + three-patch circuit breaker
  • typed Result/status handling for timeout, DFC, no-data, cancellation and transport failures
  • Stop/cancellation as a first-class deterministic path
  • bounded polling/backpressure and diagnostics
  • transactional session/config activation
  • repeated Start/Stop resource-lifecycle and performance regression gates

src/ARIEC60870.Core/AGENTS.md

  • parser ownership remains in Core
  • TryParse/Result rather than exception-driven malformed-data flow
  • strict length/index/checksum/time/numeric validation
  • unknown protocol values preserve raw evidence instead of guessed semantics
  • bounded resynchronization and hot-path allocation discipline
  • deterministic positive/negative parsing regressions

Documentation-only change; protocol/runtime behavior is unchanged.

@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: f8e0964289

ℹ️ 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".


## 1. Core authority

Core owns byte-level FT1.2/link/ASDU decoding, protocol primitives, mapping primitives, and offline analysis semantics. UI and Master may consume Core results; they must not duplicate parser truth.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Limit parser ownership to the protocols Core implements

This unqualified ownership statement conflicts with the repository's existing architecture: docs/ARCHITECTURE.md:61-75 assigns IEC-10x ASDU and IEC-104 APDU parsing to Master, where Protocol/Iec10x/Iec10xAsduDecoder.cs and Iec104ApduParser.cs already provide the canonical implementations. As written, future work on those parsers is simultaneously required to remain in Master and prohibited as duplicated parser truth; qualify this contract as IEC-103/Core-hosted parsing, or migrate the IEC-10x parsers and architecture documentation together.

Useful? React with 👍 / 👎.

@masarray
masarray merged commit 3f86d00 into master Sep 10, 2026
5 checks passed
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