Skip to content

Consolidate review checklists into a single source of truth #5

Description

@larnsce

Problem

The four review checklists (metadata, data, docs, tests) exist in 3 to 4 diverging copies:

  • CLAUDE.md (master sections, ~37 checkbox items total)
  • commands/review-package.md (first issue body template)
  • commands/review-issue.md (per-issue conditional blocks)
  • commands/create-next-issue.md (issue body templates for issues 2 to 4)
  • docs/review-checklist.csv (27 items, referenced by README as "the complete list" but used by nothing, and not matching the markdown items)

The PR body template similarly exists in 3 places with formatting drift.

Risk to manage

Consolidation can silently change the review standard. A wrong pick during merging (dropped item, wrong function name) would let packages pass review while missing checks the old workflow enforced, and defects would surface only in published packages with permanent DOIs. Depends on #4 (fix known contradictions first, so bugs are not canonicalized).

Tasks

  • Build a reconciliation table: every checklist item across all 4 markdown copies plus the 27 CSV rows, one row per item, with an explicit keep/drop/merge decision
  • Account for CSV-only items (e.g. UTF-8 encoding check) instead of deleting the CSV undiffed
  • Produce one canonical checklist file per review area, plus one canonical issue body template and one canonical PR body template
  • Update all commands and CLAUDE.md to reference (not duplicate) the canonical files
  • Commit the reconciliation table to docs/ so every dropped or altered item is on record

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions