Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/llms.txt

Use this file to discover all available pages before exploring further.

Every promoted practice in shared-best-practice.txt uses this exact eight-field block shape. No fields may be omitted. The shape is defined by the compiler protocol and enforced at both formation and manual maintenance.

​
Full block shape

id: P001
status: active
scope: global
kind: verification
applies_when: finishing a task or change
goal: ensure the change is observable before closing
do: confirm the effect of the change is visible before marking the task done
avoid: closing a task without verifying the change has taken effect

​
Field reference

​
id
string
required
Sequential practice identifier in PNNN format. Assigned at promotion — never before. Never reused.
​
status
string
required
Runtime eligibility of the practice.
  • active — applied when relevant
  • deprecated — excluded from runtime use, available for review
​
scope
string
required
Breadth of relevance.
  • global — stable across work contexts
  • environment-global — stable across the current working environment across sessions
​
kind
string
required
Practice category.
  • environment — stable environment constraint or affordance
  • orientation — setup, framing, or initial approach
  • operation — execution step or working method during real work
  • verification — check, confirmation, or closure practice
​
applies_when
string
required
Operational condition that determines relevance. Describes when — not which project or session. Should be broad enough to match recurrently but specific enough to apply at the right moment.
​
goal
string
required
Intended operational effect. States what the practice is trying to achieve. Used by Codex to interpret the do and avoid fields in context.
​
do
string
required
Primary correct default action. A direct verb instruction telling Codex what to do when the applies_when condition is matched. Short and actionable.
​
avoid
string
required
Recurring competing wrong pattern. Describes the failure mode this practice prevents. Used as a guard during execution.

​
Status transitions

FromToRequires
activedeprecatedOperator approval
deprecatedremovedDirect operator instruction

​
ID format

PNNN means: P followed by three zero-padded digits. Sequential from P001. The final id is assigned only at operator-approved promotion — never in a proposal draft.

​
Block quality rules

One block = one recurring pattern. If a block has two distinct do actions or two distinct avoid patterns, it must be split before promotion. Each field should be short enough to apply during real work — not a paragraph.

​
Multiple practice blocks

shared-best-practice.txt may contain any number of blocks, separated by blank lines between blocks. Deprecated blocks remain in the file below active ones for maintenance history.

Admission and Rejection Criteria

Learn the full set of criteria a candidate practice must meet to be admitted into CSBP, and the conditions that cause automatic rejection.

Build docs developers (and LLMs) love

Get started for freeTalk to us