Skip to content

feat(map): payload contracts in Communication and a mechanical schema pass in check (6.1.0) - #17

Merged
GentBajko merged 1 commit into
mainfrom
feat/schema-payloads
Sep 5, 2026
Merged

feat(map): payload contracts in Communication and a mechanical schema pass in check (6.1.0)#17
GentBajko merged 1 commit into
mainfrom
feat/schema-payloads

Conversation

@GentBajko

@GentBajko GentBajko commented Sep 5, 2026

Copy link
Copy Markdown
Owner

Closes the two gaps from asking "is the doc format guaranteed, down to every contract?":

  • 01-architecture.md's Communication section now mandates the payload every HTTP/websocket/event/queue/stream channel sends and receives: the named entity or DTO from 02-models.md where one exists, inline fields (name, type, optionality) where none does, with send and receive sites cited file:line. The checklist makes a bare route list fail the section, so an ad-hoc dict pushed to a broker is documented as the contract it is.
  • map check gains part 8, a mechanical schema pass (grep only, no judgment): every generated file checked for required frontmatter keys, every chapter for the required headings its topic defines. Findings count toward the stale verdict since a missing heading is template drift and a missing stamp breaks the refresh; the repair is the ordinary map refresh. doctor mirrors it as check 9.

Existing repos pick the new Communication requirement up through the template-drift path on their next refresh. Version 6.1.0 across the six manifests.

Summary by Sourcery

Strengthen reference trust checks by documenting communication payload contracts and validating generated documentation schemas.

New Features:

  • Require architecture documentation to specify bidirectional payload contracts for HTTP, websocket, event, queue, and stream communication, including inline fields when no model exists.
  • Add a mechanical schema validation pass to map check, with matching schema diagnostics in doctor.

Enhancements:

  • Make schema findings contribute to stale verdicts and identify the normal map refresh as the repair path.
  • Update communication documentation checklists and command documentation to reflect payload-contract and schema requirements.

Build:

  • Bump the project version to 6.1.0 across plugin and extension manifests.

Documentation:

  • Document payload requirements for the Communication architecture section and expand map check and doctor behavior to include schema validation.

… pass in check (6.1.0)

Two exhaustiveness guarantees the docs claimed informally but never
mandated:

- 01-architecture's Communication section now requires the payload
  each channel carries in both directions - the named model/DTO where
  one exists, inline fields where none does - cited at the send and
  receive sites. A bare route list fails the checklist.
- map check gains part 8, a grep-only schema pass: required
  frontmatter keys and required headings per generated file, counted
  toward the stale verdict; doctor mirrors it as check 9 with the map
  refresh as the repair.

Minor version: the new required content makes existing chapters
regenerate via the ordinary template-drift path, nothing breaks.

@sourcery-ai sourcery-ai 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.

Sorry @GentBajko, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 2 hours and 51 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Sep 5, 2026

Copy link
Copy Markdown

Reviewer's Guide

This PR closes the communication-contract documentation gap by requiring bidirectional payload definitions and call-site citations, and adds an eight-part mechanical schema pass to map check (mirrored by doctor) that detects missing generated-file stamps or required chapter headings and routes repairs through map refresh; all six manifests are bumped to 6.1.0.

Flow diagram for schema validation and repair

flowchart LR
    Check[map check] --> Schema[Schema pass]
    Schema --> Frontmatter[Check generated-file frontmatter]
    Schema --> Headings[Check chapter headings]
    Frontmatter --> Verdict[Stale verdict]
    Headings --> Verdict
    Verdict --> Refresh[map refresh]
    Refresh --> Regenerate[Regenerate against current template]
Loading

File-Level Changes

Change Details Files
Strengthen the architecture documentation contract for inter-component communication payloads.
  • Require payloads for HTTP, websocket, event, queue, and stream channels in both directions.
  • Use model/DTO references when available, otherwise document inline fields, types, and optionality.
  • Require send and receive call-site citations and reject bare route listings.
skills/core/references/topics.md
Add a mechanical schema validation pass to map checks and doctor diagnostics.
  • Validate generated-file frontmatter and topic-defined chapter headings with grep-only checks.
  • Count schema findings toward stale verdicts and direct repair through the normal map refresh.
  • Expose the new check in map and doctor protocols and update user-facing command documentation.
skills/core/references/protocols/map.md
skills/core/references/protocols/doctor.md
docs/commands.md
README.md
Bump the plugin and extension version to 6.1.0.
  • Update version metadata across all six manifests.
.claude-plugin/marketplace.json
.claude-plugin/plugin.json
.codex-plugin/plugin.json
.cursor-plugin/plugin.json
.kimi-plugin/plugin.json
gemini-extension.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@GentBajko
GentBajko merged commit 75014f4 into main Sep 5, 2026
1 check 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