Skip to content

Discussion: a QEP for work-plan tracking issues — genres, the body/comment discipline, and succession #15

Description

@mmcky

Per QEP-1, this is the optional discussion issue preceding a draft proposal. The question: should the org's work-plan tracking-issue practice be formalised as a QEP?

The practice exists; the convention doesn't

A search for work plan across the org's issues returns ~45 issues in 15 repositories. The recent ones are strikingly consistent in discipline and completely inconsistent in form. Four genres are tangled under one phrase:

Genre What it is Exemplars
Long-lived tracker a state register for a project's duration; revised, never session-closed QuantEcon/workspace-lectures#14, QuantEcon/QuantEcon.py#925, QuantEcon/skills#25
Period plan disposable, scoped to a session or week, chained: closes with a ledger, succeeded by a plan built from the carry-forward register the QuantEcon/project-translation session chain (issues 17 through 37), the QuantEcon/workspace-lectures weekly series (issues 23 through 50)
Handoff record a separate "what happened" issue alongside the forward plan QuantEcon/action-translation#114 — a dying genre, now folded into the plan's comments
Work package a triage's output as a family of scoped issues QuantEcon/action-translation#257 with its W0–W6 family (issues 258 through 264)

The discipline the recent issues share, nowhere written down: the body is the single source of truth for current state, revised in place, stamping its own revision date; comments are revision logs recording what changed and why, especially premises that inverted; claims are re-verified against live state, never carried forward; a period plan closes with a ledger and its successor is built from the register, never by copying the old body; and the chained repos keep exactly one open period plan at a time, which is what makes "resume the session" unambiguous.

What varies with no stated reason: six title conventions (Work plan —, TRACKING:, PLAN:, PROJECT:, W1 —, Session handoff), scoping (per-session vs per-week vs per-track), and labelling (all plan issues are currently untyped; QuantEcon/skills#25 explicitly defers to "a QuantEcon/qeps field report on plan/tracking issues", which does not yet exist).

Why a QEP

By QEP-1's own test this is QEP territory: the practice crosses repositories and changes how the team works. It also now has an operator: the qe plugin's workplan-* skill family in QuantEcon/skills (workplan-project, workplan-issue, workplan-update) encodes the observed practice, with the convention text currently held in one SKILL.md pending an upstream home. Per that repo's single-source-of-truth principle, the convention should be authored here and pointed to from there — the same relationship the style guide has to the check-style skills.

What the QEP would settle

  1. The two live genres (tracker vs period plan), their lifecycles, and when to use which.
  2. The body/comment discipline above, stated normatively.
  3. One title form per genre.
  4. The one-open-period-plan-per-repo invariant.
  5. The QEP-2 question TRACKING: work plan from 2026-07-29 — run 2 against meta, and the block-2 judgement calls skills#25 left open: whether plan/tracking issues carry a type label (the field evidence so far says untyped).
  6. Succession and closing-ledger rules.

Suggested path

Run the skill family for a few sessions first and let field experience shape the draft — the skills are new (see QuantEcon/skills#47) and their runs will surface what the convention gets wrong. Then draft the QEP from the evidence above plus those field reports.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions