Codex Shared Best Practice (CSBP)

https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice
Admin
Codex Shared Best Practice (CSBP) defines and compiles a set of shared best practices to guide...
Tokens:4,040
Snippets:74
Trust Score:6.4
Update:4 months ago
Show doc for...
Tokens:
Raw
### Runtime Practice Lifecycle States

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

Illustrates the lifecycle states and transitions for runtime practices.

```text
candidate  -> evaluate -> normalize -> promote | reject
active     -> revise
active     -> deprecate
deprecated -> remove
```

--------------------------------

### Recommended CSBP File Layout

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

This shows the recommended directory structure for CSBP files within a Codex project. Ensure CSBP-entry-point.txt is wired into your .codex/AGENTS.md.

```text
.codex/
  memories/
    CSBP-entry-point.txt
    shared-best-practice.txt
    shared-best-practice-compiler.txt

```

--------------------------------

### Runtime Practice Block Structure

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

Defines the fixed shape for each promoted runtime practice, including fields like id, status, scope, kind, applies_when, goal, do, and avoid.

```text
Field | Meaning | Runtime function
---|---|---
`id` | Sequential identifier in `PNNN` form. | Stable reference.
`status` | `active` or `deprecated`. | Determines runtime eligibility.
`scope` | `global` or `environment-global`. | Signals breadth of relevance.
`kind` | `environment`, `orientation`, `operation`, or `verification`. | Helps interpret the practice role.
`applies_when` | Operational condition. | Decides whether the practice is relevant now.
`goal` | Intended operational effect. | Explains the purpose.
`do` | Preferred default action. | Main instruction to apply.
`avoid` | Competing failure pattern. | Guard against regression.
```

--------------------------------

### License Information

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

Specifies the license under which the project is distributed.

```text
CC BY-SA 4.0
```

--------------------------------

### Kind Values Definition

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

Lists and explains the possible values for the 'kind' field in runtime practices.

```text
Value | Meaning
---|---
`environment` | Stable environment condition, constraint, or affordance.
`orientation` | Setup, framing, or initial approach.
`operation` | Execution step or working method during real work.
`verification` | Check, confirmation, or closure practice.
```

--------------------------------

### Scope Values Definition

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

Lists and explains the possible values for the 'scope' field in runtime practices.

```text
Value | Meaning
---|---
`global` | Stable across work contexts.
`environment-global` | Stable across the current working environment across sessions.
```

--------------------------------

### Proposal Shape for New Practices

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

Defines the structure for submitting new practice proposals, including candidate description, kind, scope, rationale, and proposed block.

```text
candidate:      short description of the pattern
kind:           environment | orientation | operation | verification
scope:          global | environment-global
rationale:      one short operational sentence
proposed block: full block shape draft
```

--------------------------------

### Hierarchy of Authority for Conflict Handling

Source: https://github.com/xxyoudeadpunkxx/csbp-codex-shared-best-practice/blob/main/README.md

Outlines the explicit hierarchy of authority, indicating which instructions take precedence over CSBP items.

```text
operator instruction
AGENTS.md
local project instructions or project-local guidance
```
Tokens:
Raw