Skip to content

Cleanup: strip pre-existing ephemeral issue/PR refs from code comments (repo-wide) #384

Description

@wz-gsa

Follow-up to the Durable-References guidance now in AGENTS.md §9.3/§9.4.

New PRs' comments were cleaned during review, but the rule isn't applied retroactively: ~80 pre-existing bare #NNN issue/PR references remain in scripts/**/*.py + kit scripts' comments/docstrings.

Scope

Repo-wide sweep of code comments/docstrings to rewrite bare #NNN into self-contained prose, citing an ADR (docs/decisions/) where relevant.

Keep (out of scope)

NIST control tags (> Control Mapping:); commit messages / CHANGELOG / PR bodies / ADR Links sections; test names encoding a regression id.

Approach

One comments-only PR, make validate + full test suites green. Consider a CI grep-guard to prevent regression.

AI-assisted (OpenCode). Deferred from the #352 review cleanup per the agreed our-added-lines-only scope.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationvalidationSchema, linting, tests, CI validation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions