Commentary Forms

Collect structured answers inside document-first review.

Commentary Forms live in review artifacts: Markdown, HTML, MDX, standalone YAML or JSON contracts, draft uploads, and response links. Reviewers answer them where the decision already happens.

Forms are source-backed first. Results stay permissioned by source mode, and rich renderers are sandboxed or bridged instead of running arbitrary repository JavaScript in the first-party app DOM.

  • Review-hosted
  • Response links
  • API/MCP results
  • Optional git sync

Forms stay attached to the artifact under review.

A readiness gate, beta survey, signoff checklist, or generated form contract can render beside the document, preserve review context, and produce structured result collections.

Source and results

  • SourcesMarkdown, MDX, HTML, standalone .form.yaml/.form.yml/.form.json, and draft uploads.
  • Response linksResponse links open a clean form page without full review navigation or comments.
  • HandoffAPI, MCP, exports, embedded answers, and canonical git result files make answers useful to agents and repository workflows.

How Forms move through review.

The source stays where it belongs, while Commentary handles fill, validation, result ownership, and structured handoff.

  1. 01

    Author in source

    Add a form block or standalone contract to a PR, branch, draft upload, or response link source.

  2. 02

    Fill in context

    Reviewers answer the fields while reading the document-first review surface.

  3. 03

    Own the results

    PR/branch results follow source write access, draft results default to the draft owner, and response-link results belong to the link owner.

  4. 04

    Hand off answers

    Use API/MCP, embedded-answer reads, exports, or optional canonical git result sync.

What Forms are for.

Use Forms when a review needs structured answers, not a separate survey tool detached from the reviewed artifact.

Document-first filling.

Reviewers fill embedded forms in the same rendered Markdown, MDX, or static HTML review context where they are reading comments and source evidence.

Draft authoring before Git.

Draft Reviews can upload form contracts beside Markdown, HTML, or MDX so teams can test a review form before committing the source.

Open draft Forms sample

Response link mode.

A response link gives respondents a clean form page with minimal chrome and no file navigator, full review navigation, or comments pane.

Safe rich rendering.

Custom renderers use sandboxed or nonce-bound bridge messages. Commentary keeps the machine-readable Form Contract authoritative.

Read renderer docs
Result ownership

Answers are not broadly visible just because a form is easy to fill.

PR and branch results are listed for viewers with trusted source write access. Draft review results default to the draft owner. Response-link results belong to the response-link owner, and anonymous mode only applies when explicitly configured.

Git source permissionsDraft owner resultsResponse link owner

Built for agents and repository workflows.

Structured answers should be readable by the people, agents, and git workflows that need to act on them.

Developer surfaces can validate contracts, submit answers, list permitted result collections, read embedded answers, export submissions, inspect writeback status, and trigger explicit git result sync actions.

License feature keys

  • Free previewforms.basic and forms.github_source cover core review-hosted Forms evaluation.
  • Free handoffforms.agent_api and forms.embedded_reviews cover current API/MCP and embedded review result paths.
  • Pro previewforms.custom_renderer and forms.github_writeback cover custom renderer bridge and explicit git sync paths.
  • No billingPro-preview features remain usable during the current no-billing phase and should show the reusable Pro notification in product UI.

Open the Forms sample that matches your workflow.

Start with a Git-backed review form, draft-authored form, response link, or results sync example before moving to your own artifact.