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.
shared-best-practice.txt is the only CSBP file that changes at runtime. It stores already-promoted practices in a fixed block shape and defines how Codex reads and applies them during a session. Changes to this file may only occur through the compiler path and with operator approval.
File identity
| Property | Value |
|---|
| Name | shared-best-practice.txt |
| Version | 0.1 |
| Role | Runtime store for promoted practices |
| Mutable | Yes — through compiler path and operator approval only |
Authority
The runtime file does not redefine policy, scope, or authority. See CSBP-entry-point.txt for the full authority order.
Use
- Apply only when
applies_when matches current work
- Active entries guide current work decisions
- Deprecated entries do not guide runtime use
- Deprecated entries remain available for review only
Read order
When processing a practice block at runtime, Codex follows this sequence:
- Check
status
- If status is
deprecated, stop reading the block
- Check
applies_when
- Use
goal for interpretation
- Apply
do as default action
- Use
avoid as competing-pattern guard
Block shape
Every promoted practice uses this fixed eight-field shape:
id: PNNN sequential practice identifier
status: whether the practice is active for runtime use
scope: whether the practice is global or environment-global
kind: practice category used for interpretation
applies_when: operational condition for relevance
goal: intended operational effect
do: primary default action
avoid: recurring competing pattern
For full field definitions and validation rules, see the Block Schema reference.
Status values
| Value | Runtime behavior |
|---|
active | Use at runtime when relevant |
deprecated | Exclude from runtime use; available for review only |
Scope values
| Value | Meaning |
|---|
global | Stable across work contexts |
environment-global | Stable across the current working environment across sessions |
Kind values
| Value | Meaning |
|---|
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 |
Write rule
Runtime practice changes must follow shared-best-practice-compiler.txt. Do not add, revise, deprecate, or remove a runtime practice without operator approval.
Empty state
The runtime file may contain no active practices. That is a valid state. Codex continues without CSBP guidance when there are no relevant active practices.