Skip to content

Broader prose-audit sweep for non-deleted-symbol planning artifacts (runbooks + docstrings) #817

@michael-wojcik

Description

@michael-wojcik

Background

PR #808 deferred a broader prose-audit sweep across runbook and test-docstring surfaces. The completed scope of #808 was strictly the deleted-helper-symbol references introduced by the is_lead_context consolidation. There remain non-deleted-symbol planning artifacts that should be audited per feedback_no_planning_artifacts_in_repo:

F-row labels, sketch IDs, issue/PR refs, architect sections, and similar planning identifiers must be absent from source, docstrings, test names, runbook prose, env-vars, error messages, journal fields, AND commit messages — repo must self-describe.

Scope

Grep + behavioral-rewrite sweep across:

  1. pact-plugin/tests/runbooks/ — all .md and .sh files
  2. Production hook docstringspact-plugin/hooks/**/*.py
  3. Test file docstringspact-plugin/tests/**/*.py

Patterns to find

  • Bare #NNN issue/PR references in prose (where the reference is a planning-artifact, not a durable cross-ref)
  • F-row labels (F1-test, F2-bc, F3-arch, etc.) — cycle-internal markers
  • Sketch IDs (B1, N1, D1, etc.) — review-cycle markers
  • Architect-section labels (Section A, Section B, etc.) — planning identifiers
  • In-flight task IDs (Task #NN) where the reference is markup rather than a durable cross-ref
  • Cycle references (cycle-2 adoption, etc.) that no longer locate anything actionable

Methodology

Apply the cycle-3 refinement discipline (feedback_pact_no_planning_artifacts_in_repo + cycle-3 refinement memory): durable cross-refs OK (e.g., pact-protocols.md §X.Y); embedded phase-aliases are the failure mode.

For each hit:

  • If it's a durable cross-ref to a stable artifact (file path, function name, protocol section), leave it.
  • If it's a phase-alias to a deleted or moving target, rewrite to behavioral language describing what the thing does.

Verification

Final grep across the audit surface should show:

  • Zero F-row labels
  • Zero sketch IDs
  • Zero in-flight task IDs in source/docs
  • Issue/PR refs only in commit messages, PR descriptions, and durable cross-ref contexts (e.g., "see follow-up #NNN")

Origin

Surfaced by test-engineer-refactor during PR #808's N1 fix dispatch + commitment from prior session compaction to file as post-merge follow-up. PR #808's option-4 cleanup addressed the deleted-helper-symbol class; this is the broader sweep.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions