36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
# Standard Pull Request Telemetry Template
|
|
|
|
Use this markdown structure for automated pull request bodies (`gh pr create --body-file ...`)
|
|
and formal task completion records:
|
|
|
|
```markdown
|
|
## 1. WHAT (System Modifications)
|
|
- **Modified Components**:
|
|
- `path/to/modified_file.ext`
|
|
- **Added Assets**:
|
|
- `path/to/new_file.ext`
|
|
- **Removed Assets**:
|
|
- None
|
|
|
|
## 2. WHY (Context & Architectural Intent)
|
|
- **Problem Statement**: Concise description of defect, bottleneck, or requirement.
|
|
- **Requirement Traceability**: Issue # / Task ID / Plan bead.
|
|
- **Design Justification**: Rationale for chosen implementation architecture.
|
|
|
|
## 3. HOW (Technical Implementation & Verification Evidence)
|
|
- **Implementation Details**: Summary of algorithmic, API, or structural updates.
|
|
- **Deterministic Verification Evidence**:
|
|
- **Command**: `pytest tests/unit/test_target.py -v`
|
|
- **Exit Code**: `0`
|
|
- **Output Metrics**: `XX passed, 0 failed, 100% pass rate`
|
|
- **Static Analysis & Linting**:
|
|
- **Command**: `ruff check src/`
|
|
- **Result**: Clean (0 errors)
|
|
|
|
## 4. LEARNINGS & ARCHITECTURAL GOTCHAS
|
|
- **Operational Traps**: Specific runtime, environment, or dependency quirks discovered.
|
|
- **Uncovered Debt**: Latent issues, missing coverage, or obsolete patterns identified.
|
|
- **Indexed Gotchas**: Reference to saved `docs/gotchas/<slug>.md` if applicable.
|
|
- **Follow-up Recommendations**: Subsequent tasks or architectural considerations.
|
|
```
|