Skills › BMAD Method › bmad-review › customize.toml
customize.toml
141 lines · skills/bmad-review/customize.toml at bd70c64
1# DO NOT EDIT -- overwritten on every update.
2#
3# Workflow customization surface for bmad-review.
4#
5# Override files (not edited here):
6# {project-root}/_bmad/custom/bmad-review.toml (team)
7# {project-root}/_bmad/custom/bmad-review.user.toml (personal)
9[workflow]
11# --- Configurable below. Overrides merge per BMad structural rules: ---
12# scalars: override wins
13# arrays (persistent_facts, activation_steps_*, review_guidance): append
14# arrays of tables keyed by `code`: matching key replaces, new keys append
16# Steps executed on activation: prepend runs before the skill's own
17# activation flow, append runs after the lens plan is settled and before the
18# lenses run. Each entry is a literal instruction.
19activation_steps_prepend = []
20activation_steps_append = []
22# Standing context held for every review, code and document alike. Entries
23# prefixed `file:` are paths or globs whose contents load as facts; all others
24# are literal facts. The shipped entry is a project-wide glob — set it to []
25# if you don't want every review scanning for it.
26persistent_facts = []
28# Standing review directives applied on every run alongside each lens's own
29# method. Each entry is a literal sentence or a `file:`-prefixed path/glob
30# whose contents load as directives.
31#
32# Examples:
33# "Flag passive voice in headings."
34# "Second-person imperative is the house voice; never suggest changing it."
35# "file:{project-root}/docs/terminology.md"
36review_guidance = []
38# Executed after the findings are delivered. Freeform directive; empty = the
39# review ends with the findings.
40#
41# Example:
42# on_complete = "Append a one-line review summary to {project-root}/docs/review-log.md"
43on_complete = ""
45# How findings are presented when the caller doesn't say: "json" (the raw
46# findings array only), "markdown" (the human report only), or "both". A lens
47# that declares its own rendering keeps it for its own findings.
48output_format = "both"
50# Where to write the review report. Empty = present in chat only. Accepts
51# {project-root}-prefixed paths.
52report_path = ""
54# How findings are presented — shaping, not destination. Freeform directive;
55# empty = each lens's default ordering and rollup.
56#
57# Example:
58# output_preferences = "Cap output at the 20 highest-impact findings."
59output_preferences = ""
61# --- Editorial lens settings (used by the structure and prose lenses) ---
63# Default reader the editorial lenses calibrate for when the request doesn't
64# say:
65# "humans" clarity, flow, comprehension aids preserved
66# "llm" precision, consistent terminology, no hedging
67# A reader type stated in the request wins for that run.
68reader_type = "humans"
70# The baseline style guide for every editorial review: the name of a guide the
71# model knows well, a `file:`-prefixed path to a style guide document, or the
72# rules inline as text. A style guide stated in the request wins for that run.
73# Where the guide in effect conflicts with the lens's generic principles, the
74# guide wins — except content is sacrosanct.
75#
76# Examples (set in team/user override TOML):
77# style_guide = "file:{project-root}/_bmad/style-guides/company-voice.md"
78# style_guide = "Sentence-case headings. No Oxford comma. Address the reader as 'you'."
79style_guide = "Microsoft Writing Style Guide"
81# ---------------------------------------------------------------------------
82# Review lenses. Each lens is a pass over the content with its own method and
83# stance. `instruction` is the lens's whole execution recipe — the shipped
84# lenses load a reference file from the skill root, but an override may inline
85# any prompt.
86#
87# `applies_to` is the content this lens can review: "code", "docs", or "any".
88# It is the first filter — a lens never joins a default review for content it
89# does not apply to. `when` (optional) refines that judgement in prose. An
90# explicitly requested lens always runs, whatever both say.
91#
92# `after` (optional) names a lens this one builds on: it runs once that lens
93# has completed and receives its findings, instead of running independently.
94#
95# Empty `instruction` disables a lens. Keyed by `code`: an override with a
96# matching code replaces the shipped lens, a new code appends.
97#
98# Example (add an org-specific lens in team/user override TOML):
99# [[workflow.lenses]]
100# code = "accessibility"
101# name = "Accessibility"
102# applies_to = "any"
103# when = "UI code or user-facing documents."
104# instruction = "Review against WCAG 2.2 AA. Emit findings in the canonical fields."
105# ---------------------------------------------------------------------------
107[[workflow.lenses]]
108code = "adversarial"
109name = "Adversarial"
110applies_to = "any"
111when = "always"
112instruction = "Load `references/lens-adversarial.md` from the skill root and follow it."
114[[workflow.lenses]]
115code = "edge-case-hunter"
116name = "Edge-Case Hunter"
117applies_to = "any"
118when = "Content with behavior to trace: code, diffs, and the tickets, plans, and requirements that define behavior. Skip for prose documents with no behavioral surface."
119instruction = "Load `references/lens-edge-case-hunter.md` from the skill root and follow it."
121[[workflow.lenses]]
122code = "verification-gap"
123name = "Verification Gap"
124applies_to = "code"
125when = "Reviewed inside a repo where tests can be searched and read."
126instruction = "Load `references/lens-verification-gap.md` from the skill root and follow it."
128[[workflow.lenses]]
129code = "structure"
130name = "Editorial Structure"
131applies_to = "docs"
132when = "Documents whose shape is the author's to change."
133instruction = "Load `references/lens-structure.md` from the skill root and follow it."
135[[workflow.lenses]]
136code = "prose"
137name = "Editorial Prose"
138applies_to = "docs"
139after = "structure"
140when = "Documents being copy-edited."
141instruction = "Load `references/lens-prose.md` from the skill root and follow it."