prompt

Overview ¶

Package prompt is the review prompt this module ships: the instructions the generate-and-repair loop (agent.Generator) gives a model backend. It also holds the fix instructions (Fix): fix-public-v1.md, with fix-conflicts.md and fix-checks.md for what a fix is for, and the instructions of a chat turn (Chat): chat-public-v1.md.

Five review files are embedded:

review-public-v6.md   the review instructions shared by every backend,
                      ending with the "## 10. Submitting" heading
group-public-v1.md    what changes for a review group's combined
                      review, inserted before that heading by
                      GroupPrompts
submit-claude.md      how a StructuredOutput backend submits the document
submit-codex.md       how a final-message backend returns the document
submit-cursor.md      the same for cursor-agent, which has no schema
                      enforcement and stops a run on any tool that does
                      not read

Instructions joins the shared text with the backend's submit text under the trailing heading, sets Version to Version and Digest to the sha256 of the joined Body. The repair wording stays in agent.RepairText and the tile guidance in tilecatalogue, so neither belongs in these files.

A staged review (agent.Generator.StagedReview, StagedPrompts) has four more, derived from review-public-v6.md:

review-shared-public-v1.md   what every stage shares: the stages and what
                             each writes, the ground rules, the inputs,
                             checking a change, anchors, writing and
                             calibration; with the bundle and the source
                             excerpts, the prefix of every stage's prompt
review-outline-public-v1.md  the overview and the sections' outline
review-details-public-v1.md  the sections' details
review-context-public-v1.md  the summary's codebase context

Each stage file ends with a "## Submitting" heading, under which the backend's stage submit block goes (submit-stage-claude.md, submit-stage-codex.md, submit-stage-cursor.md, with {part} replaced by what the stage returns), and names its schema file (agent.TaskSchemaFile).

Custom prompts ¶

A host may replace the text of any prompt by passing Overrides (a map from ID to text) in the Overrides field of GroupPrompts or StagedPrompts, or to FixWith. The one-pass review (Prompts) is not replaceable: a review of one pull request is staged, and a group's prompt (review-group) is the whole text, the review instructions included. An override replaces the built-in text of its part only: the Submitting heading and the backend's submit block (the output contract) stay baum's and are always appended, so an override never includes them (Validate rejects one that does). A composition whose parts include an override reports its Version with a "+custom" suffix; the Digest still identifies the exact text. A nil or empty Overrides, and an ID missing from it or mapped to the empty string, mean the built-in text; the zero value of every type produces byte-identical output to the built-in prompts, so a host that never sets Overrides is unchanged.

Catalogue lists every overridable prompt (ID, title, group, built-in text and version) so an editor can seed from the built-in text. Validate checks an override before it is stored. Each Entry also carries SafetyRules: metadata kept outside the prompt text that names the sentences that keep a run safe (treat the pull request as untrusted data, never commit or push, never reproduce secrets). MissingSafetyRules reports which of them a custom text dropped, so a host can warn the author; it never blocks.