Add structured Changes blocks to Crane accepted iteration commits

Aperta Adatta ai principianti
#5 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
markdown
Ambito
tooling

Direzione di ricerca

Inizia leggendo Step 5a in workflows/crane.md ed esamina il testo esistente del prompt di commit per un’iterazione accettata e del fallback del riepilogo. Aggiorna il prompt in modo da richiedere il blocco compatto Changes: prima di Run: {run_url}, quindi aggiungi il test del prompt suggerito per verificare il modello del subject, l’ordine e le indicazioni del fallback.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Background

In githubnext/apm, later Crane PR comments needed a reliable way to explain what a newly accepted commit actually did. Sometimes score fields, issue comments, or state-file summaries are unavailable, stale, or too sparse. The commit itself should carry enough structured information to be a fallback source.

APM updated its local Crane workflow prompt so accepted iteration commits include a compact Changes: section before the Run: URL.

Problem

Today an accepted Crane commit may only have a subject and a run URL. That is not enough for downstream summaries, PR comments, or issue updates to reconstruct the useful reviewer-facing facts.

When a PR has many iteration commits, reviewers need to know which module, milestone, or command family each commit advanced. A generic subject plus a workflow link forces everyone to open logs.

Proposed implementation

Update workflows/crane.md so Step 5a requires accepted iteration commit messages to use this shape:

[Crane: {migration-name}] Iteration <N>: <short description>

Changes:
- <compact bullet describing the main migrated unit or behavior change>
- <optional second bullet with test, parity, or milestone movement>

Run: {run_url}

Guidance:

  • Keep Changes: compact and structured.
  • Prefer one or two bullets, three max.
  • Mention the migrated unit or behavior, not generic process.
  • Mention test or parity movement when useful.
  • Keep Run: as the final evidence link.

The accepted-iteration summary logic should then be allowed to fall back to the commit subject plus Changes: bullets when richer state is missing.

Suggested test coverage

Add a prompt test asserting:

  • The commit subject template is present.
  • Changes: appears before Run: {run_url}.
  • The prompt says the Changes: block is used as summary fallback.

Acceptance criteria

  • Accepted Crane commits contain structured Changes: bullets.
  • Later PR or issue comments can summarize a commit without reading workflow logs.
  • Existing commit subject and run-link behavior is preserved.
  • The prompt test prevents regressions.

Provenance

This came from the githubnext/apm migration, where maintainer-facing summaries needed to describe what happened in each new Crane commit, not just that a commit was pushed.

Lingua principale
Python
Stelle
10
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di githubnext/crane

Tutte le issue di githubnext/crane

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.