Skip to content

Bring maintainer documents and comments in line with the code - #446

Merged
jeff377 merged 2 commits into
mainfrom
claude/p3-maintainer-docs
Nov 12, 2026
Merged

jeff377 merged 2 commits into
mainfrom
claude/p3-maintainer-docs

Conversation

@jeff377

@jeff377 jeff377 commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Part of #441

Maintainer documents and code comments that had drifted from the code. No behavior change.

  • ADRs: ADR-043 and ADR-049 gain status notes and the later evolution of their decisions; ADR-015 points to the current Northwind credential types and the public demo master key notice; ADR-033 records two evolution items, including that the server does not normalize time-of-day values.
  • tests/CLAUDE.md: the WorkloadFact section points to the attribute's XML doc, notes the template package collection, and says that S2699 is enforced only by the full-mode Sonar build.
  • The serialization skill's template uses JsonCodec; a stale line in the test/CI gotchas is corrected.
  • Comments in PolhemMethodPolicy, PolhemFrameworkServiceCollectionExtensions, TestProcessBootstrap and the AnonymousApiSurfaceTests text name the types that do the work today.

Verified locally: check-md-links.sh, check-public-docs.sh, check-docs-i18n.sh, check-dependency-map.sh; the pre-commit hook's clean Release build. CI: lite.

ADR-043 and ADR-049 record where the error mapper and its log category moved (ADR-049, 051, 055). ADR-015 and the test bootstrap name the Northwind demo key instead of the removed samples. ADR-033 records that time-of-day values are normalized on the client only, so the sort guarantee holds only for values that went through it. tests/CLAUDE.md documents [WorkloadFact], the template package collection, and that S2699 is a SonarCloud rule. The serialization skill's JSON round trip uses the framework's options; a gotcha names the codec that replaced MessagePackPayloadSerializer. Comments on PolhemMethodPolicy, the anonymous surface test and the customization layer registration describe the current code.
ADR-033 says ToFieldValue never ran on a write path; ADR-043's new entry is in date order and scopes 'of their date' to the whole ADR; ADR-049 records the moved log category as an Amended note; tests/CLAUDE.md points to the WorkloadFact XML doc instead of restating it, marks the template collection as the one non-static definition, and says S2699 is enforced only by the full-mode build.
@jeff377
jeff377 enabled auto-merge (squash) November 12, 2026 13:35
@jeff377
jeff377 merged commit 077e2d3 into main Nov 12, 2026
3 checks passed
@jeff377
jeff377 deleted the claude/p3-maintainer-docs branch November 12, 2026 13: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