Scrum4Me/docs/plans/ST-1114-copilot-reviews.md
Janpeter Visser 7e45bbdbc0
docs: AI-optimized docs restructure (Phases 1–8) (#61)
* docs(dialog-pattern): add generic entity-dialog spec

Introduceert docs/patterns/dialog.md als bron-of-truth voor elke
create/edit/detail-dialog in Scrum4Me, ongeacht het achterliggende
dataobject. Bevat 14 secties: uitgangspunten, stack, component-
architectuur, layout, validatie, drielaagse demo-policy, submission,
dialog-gedrag, theming, footer, triggers/URL-state, per-entiteit
profile-template, out-of-scope, en een verificatie-checklist.

Registreert het patroon in CLAUDE.md "Implementatiepatronen"-tabel
zodat Claude (en mensen) de spec verplicht raadplegen voor elke
nieuwe dialog.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* docs(dialog-pattern): convert task spec + add pbi/story entity-profiles

Reduceert docs/scrum4me-task-dialog.md van 507 naar ~140 regels: alle
gedeelde regels verhuisd naar docs/patterns/dialog.md, dit document
bevat nu alleen Task-specifieke velden, URL-pattern, status-veld,
server actions, triggers en bewuste out-of-scope-keuzes.

Voegt twee nieuwe entity-profielen toe voor bestaande dialogen:
- docs/scrum4me-pbi-dialog.md (PbiDialog: state-based, code+title-rij,
  PbiStatusSelect, geen delete in v1)
- docs/scrum4me-story-dialog.md (StoryDialog: state-based, header met
  status/priority badges, inline activity-log, demo-readonly-fallback,
  inline-delete-confirm i.p.v. AlertDialog)

Beide profielen documenteren expliciet de "Bekende gaps t.o.v.
generieke spec" zodat opvolgende PR's de afwijkingen kunnen
rechtzetten of bewust kunnen accorderen.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Added pdevelopment docs

* docs(plans): add docs-restructure plan for AI-optimized lookup

Audit of existing 39 doc files (~10.700 lines) and a phased restructure
proposal aimed at minimising the tokens an AI agent has to read to find
the right reference. Captures resolved decisions on language (English),
ADR template (Nygard default with MADR escape-hatch), index generator
(node script), and folder taxonomy. Proposal status — fase 1 to follow.

* docs(adr): add ADR scaffolding (templates, README, meta-ADR)

Set up docs/adr/ as the canonical home for architecture decisions:

- templates/nygard.md — default four-section format (Status, Context,
  Decision, Consequences) for one-way-door decisions.
- templates/madr.md — MADR v4 with YAML front-matter and explicit
  Considered Options for decisions where rejected alternatives matter.
- README.md — naming convention (NNNN-kebab-case), template-selection
  guidance (Nygard default; MADR for auth, queue mechanics, agent
  integration), status lifecycle, and ADR roster.
- 0000-record-architecture-decisions.md — meta-ADR establishing the
  practice itself, in Nygard format.

Backfilling existing implicit decisions (base-ui-over-radix, float
sort_order, demo-user three-layer policy, etc.) is fase 6 of the
docs-restructure plan.

* feat(docs): add docs index generator + initial INDEX.md

scripts/generate-docs-index.mjs walks docs/**/*.md, parses YAML
front-matter (or first H1 fallback) and a Nygard-style ## Status
section, then writes docs/INDEX.md with grouped tables for ADRs,
Specs, Plans (with archive subsection), Patterns, and Other.

Pure Node 20 (no external deps); idempotent — running it twice
produces byte-identical output. Excludes adr/templates/, the ADR
README, INDEX.md itself, and any *_*.md sidecar file.

Wire-up:
- package.json: docs:index → node scripts/generate-docs-index.mjs

Initial run indexed 35 docs across the existing structure; the
generated INDEX.md is committed so the table is reviewable in the
PR before hooking generation into a pre-commit step.

* chore: ignore Obsidian vault and personal sidecar files

Add .obsidian/ (Obsidian vault config) and _*.md (personal sidecar
notes) to .gitignore so the docs/ tree can serve as canonical source
of truth while still being usable as an Obsidian vault for personal
authoring. The docs index generator already excludes the same _*.md
pattern from INDEX.md.

* docs(plans): add PBI bulk-create spec for docs-restructure

Machine-parseable spec for an executor that calls the scrum4me MCP
(create_pbi → create_story → create_task) to seed the docs-restructure
work into the DB.

- Section 1 (Context) is the PBI description; serves as task-context
  via mcp__scrum4me__get_claude_context.
- Section 2 lists the 6 resolved decisions (English, MD3+styling
  merged, solo-paneel merged, .Plans archived, Nygard ADR default,
  node index script).
- Section 3 records what already shipped on this branch so the
  executor doesn't duplicate the ADR scaffolding or index generator.
- Section 4 carries the structured YAML graph: 1 PBI, 8 stories
  (one per phase), 39 tasks. product_id is REPLACE_ME — fill before
  running.
- YAML validated with PyYAML; field schema sanity-checked.

* docs(junk-cleanup): remove stub patterns/test.md

* docs(junk-cleanup): archive .Plans/ to docs/plans/archive/

* docs(front-matter): add YAML front-matter to docs/ root

* docs(front-matter): add YAML front-matter to patterns/

* docs(front-matter): add YAML front-matter to plans + agent files

* docs(index): regenerate INDEX.md after front-matter pass

* docs(naming): drop scrum4me- prefix from doc filenames

* docs(naming): lowercase API.md and MD3 filenames

* docs(naming): rename plan file to kebab-case ASCII

* docs(naming): rename middleware.md to proxy.md (next 16)

* docs(naming): polish CLAUDE.md doc-index after renames

* docs(taxonomy): scaffold topical folders under docs/

* docs(taxonomy): move spec files into docs/specs/

* docs(taxonomy): move design/api/qa/backlog/assets into folders

* docs(taxonomy): move agent-instruction-audit into decisions/

* docs(split): break architecture.md into 6 topical files

* docs(split): merge solo-paneel-spec into specs/functional.md

* docs(split): merge md3-color-scheme into design/styling

* docs(trim): extract branch/commit rules into runbook

* docs(trim): extract MCP integration into runbook

* docs(adr): add 0001-base-ui-over-radix

* docs(adr): add 0002-float-sort-order

* docs(adr): add 0003-one-branch-per-milestone

* docs(adr): add 0004-status-enum-mapping

* docs(adr): add 0005-iron-session-over-nextauth

* docs(adr): add 0006-demo-user-three-layer-policy

* docs(adr): add 0007-claude-question-channel-design

* docs(adr): add 0008-agent-instructions-in-claude-md + update README index

* docs(index): regenerate after ADR 0001-0008

* docs(glossary): add docs/glossary.md

* chore(docs): regenerate INDEX.md in pre-commit hook

* docs(readme): link INDEX + glossary + agent instructions

* feat(docs): add doc-link checker script

* chore(docs): wire docs:check-links and docs npm scripts

* ci(docs): block merge on broken doc links

* docs(links): fix broken cross-references after restructure

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-03 03:21:59 +02:00

7.1 KiB

title status audience language last_updated applies_to
ST-1114 — Copilot reviews op dashboard active
maintainer
contributor
nl 2026-05-03
ST-1114

Plan — ST-1114 · Copilot reviews op dashboard

Context

Als ontwerper wil je een overzicht zien van GitHub Copilot's PR-reviews om per stuk te beslissen of je 'm implementeert of overslaat. De codebase heeft nu nul GitHub-integratie — alleen product.repo_url als string voor hyperlinks. We bouwen een minimale, hobby-vriendelijke architectuur.

Architectuurkeuzes (via AskUserQuestion bevestigd)

  • Auth: lokaal script met GITHUB_TOKEN — webapp heeft GEEN GitHub-credentials. Het script draai je lokaal wanneer je wil verversen.
  • Fetch: on-demand op dashboard-load (server-side prisma.copilotReview.findMany, geen externe call)
  • Decision: alleen visuele toggle in localStorage (geen DB-persistentie)
  • Scope: MVP — tonen + lokale toggle. Geen cron, geen webhook, geen GitHub-auth in productie.

Architectuur

┌──────────────┐   octokit   ┌────────────┐   API token   ┌─────────────┐
│ scripts/     │ ──────────▶ │  GitHub    │               │  Scrum4Me   │
│ sync-copilot │             │  REST API  │               │  /api/      │
│ -reviews.ts  │ ◀────────── │            │               │  copilot-   │
└──────────────┘   reviews   └────────────┘   POST batch  │  reviews    │
        │                                                  │             │
        └──────────────────────────────────────────────────▶ DB upsert  │
                                                            └──────┬──────┘
                                                                   │
                                                            ┌──────▼──────┐
                                                            │  /dashboard │
                                                            │ server-side │
                                                            │ findMany    │
                                                            └─────────────┘

Het script is de enige plek waar GitHub-credentials nodig zijn. Productie kent alleen Scrum4Me-data.

Datamodel

model CopilotReview {
  id            String   @id @default(cuid())
  product       Product  @relation(fields: [product_id], references: [id], onDelete: Cascade)
  product_id    String
  pr_number     Int
  pr_title      String
  pr_url        String
  pr_state      String   // 'open' | 'closed' | 'merged'
  author_login  String   // bv. 'copilot-pull-request-reviewer[bot]'
  review_state  String   // 'COMMENTED' | 'APPROVED' | 'CHANGES_REQUESTED'
  body          String   @db.Text
  submitted_at  DateTime
  html_url      String   // directe link naar de review
  fetched_at    DateTime @default(now())

  @@unique([product_id, pr_number, submitted_at])
  @@index([product_id, submitted_at])
  @@map("copilot_reviews")
}

@@unique zorgt voor idempotency — script kan herhaald draaien zonder dupes. Geen decision-veld: dat staat in localStorage.

Script

scripts/sync-copilot-reviews.ts — TypeScript via tsx, leest env, gebruikt Octokit, POST naar eigen API.

GITHUB_TOKEN=ghp_... \
SCRUM4ME_API_URL=http://localhost:3000 \
SCRUM4ME_API_TOKEN=s4m_... \
npx tsx scripts/sync-copilot-reviews.ts

Stappen:

  1. GET /api/products (Bearer-auth) — lijst toegankelijke producten met repo_url
  2. Per product: parse owner/repo uit repo_url, octokit.pulls.list({state: 'all', per_page: 50})
  3. Per PR: octokit.pulls.listReviews(...), filter op user.type === 'Bot' && user.login.includes('copilot')
  4. POST /api/copilot-reviews met { product_id, reviews: [...] } — endpoint doet deleteMany + createMany per product (atomic replace)
  5. Print samenvatting: aantal reviews per product + totale runtime

API endpoint

app/api/copilot-reviews/route.ts:

  • POST: Bearer-auth, demo-block, payload { product_id, reviews: CopilotReview[] }. Atomic transaction: delete-all-for-product → createMany. Validatie via Zod.
  • GET: niet nodig — dashboard leest direct via Prisma server-side. Endpoint kan komen voor toekomstige clients.

Dashboard widget

Boven of onder de bestaande product-grid een nieuwe sectie "Copilot reviews".

components/dashboard/copilot-reviews.tsx (client component):

  • Props: reviews: CopilotReview[] (server-fetched)
  • Lijst met cards: PR-titel + nummer (link naar PR), Copilot's body (truncated of accordion), state-badge, "Implementeer" / "Skip"-knoppen
  • Decision-state in localStorage keyed op review.id: 'implement' | 'skip' | undefined (default: ongezien)
  • Cards met decision='skip' visueel gedimmed; cards met 'implement' krijgen een groen randje
  • Filter-toggles bovenaan: "Alle / Te beoordelen / Implementeren / Skip"
  • Empty state: "Geen Copilot-reviews gevonden — draai het sync-script."

app/(app)/dashboard/page.tsx past prisma.copilotReview.findMany({ where: { product_id: { in: accessibleIds } }, orderBy: { submitted_at: 'desc' } }) en geeft door.

Voorgestelde sub-tasks

Code Onderwerp
ST-1114.2 DB: CopilotReview model + migration
ST-1114.3 API: POST /api/copilot-reviews (Bearer-auth + demo-block + replace-by-product)
ST-1114.4 Script: scripts/sync-copilot-reviews.ts met octokit
ST-1114.5 UI: dashboard-widget met cards, localStorage-decision, filter-toggle
ST-1114.6 Tests: API endpoint (auth, demo-block, validation), dashboard-widget snapshot
ST-1114.7 Docs: README-sectie over script + env-vars; CLAUDE.md-update

M11-keuzes voor de implementerende sessie

Drie open beslissingen die niet kritiek zijn voor het plan zelf:

  1. PR-state filter: alle PR's of alleen state=open? (closed-PRs hebben oude reviews die misschien niet meer relevant zijn)
  2. Markdown-rendering: react-markdown, of plain <pre>? (react-markdown is +35KB bundle)
  3. localStorage-key-vorm: scrum4me:copilot-decision:{review_id} per review, of één map-object onder één key?

Branch + PR

  • Branch: feat/M14-copilot-reviews (M14 = nieuwe milestone)
  • 6 commits (.2 t/m .7), één per laag
  • PR pas openen na handmatige test door gebruiker

Verificatie (end-to-end)

  1. npm run dev
  2. GITHUB_TOKEN=... SCRUM4ME_API_TOKEN=... npx tsx scripts/sync-copilot-reviews.ts — toont n reviews opgeslagen
  3. Browser refresht dashboard → "Copilot reviews"-sectie toont cards met PR-titels
  4. Klik "Implementeer" → kaart krijgt groen randje, decision in localStorage
  5. Refresh → state blijft (localStorage)
  6. Filter toggle "Alleen te beoordelen" → cards met decision verdwijnen
  7. Demo-user: kan reviews zien, maar POST /api/copilot-reviews weigert (al via middleware-guard van ST-1110)