Skip to content

Shipped library comments reference internal process artifacts (slice #NN, PR notes, risk #23, #44, PLAN.md) #121

@nficano

Description

@nficano

Category: clean-code Severity: minor
Location: packages/core/src/messages/events.ts:11-14

What

Multiple published-source comments cite internal workflow artifacts meaningless to SDK consumers: events.ts:13 ('slice #35'); lease-schema.ts:45 ('PR notes for slice #50'); client-effect.ts:24-26,236-239,271-274 ('risk #23', 'the issue's acceptance criterion'); job-effect.ts:15 ('#44'); util/json-schema.ts:4-5 and websocket.ts ('@see PLAN.md').

Evidence

// Bodies for `log`, `metric`, and `artifact_ref` are imported from their
// owning modules (slice #35 migrated them); the remaining bodies are
// defined here as native Effect `Schema`.

Proposed fix

Remove internal slice/PR/risk/issue and PLAN.md references from shipped comments; describe behavior or cite the spec section instead.

Acceptance criteria

  • No 'slice #', 'PR notes', 'risk #NN', bare '#NN', or 'PLAN.md' references remain in library comments.

Metadata

Metadata

Assignees

No one assigned

    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