docs(guidelines): Define Structural Dependency Mapping (SDM) convention
This commit is contained in:
@@ -38,3 +38,6 @@
|
||||
- **Indentation:** Exactly **1 space** per level. This minimizes token usage in nested structures.
|
||||
- **Newlines:** Maximum **one (1)** blank line between top-level definitions. **Zero (0)** blank lines within function or method bodies.
|
||||
- **Type Hinting:** Mandatory, strict type hints for all parameters, return types, and global variables to ensure high-signal context for AI agents.
|
||||
- **Structural Dependency Mapping (SDM):** All major state variables, methods, and functions MUST include terse dependency tags at the end of their docstrings for AI-assisted impact analysis.
|
||||
- **Functions/Methods:** `[C: Caller1, Caller2]` (Primary callers).
|
||||
- **State Variables:** `[M: File:Line, Method]` (Mutation points) and `[U: File]` (Major use paths).
|
||||
|
||||
Reference in New Issue
Block a user