ce-compound: line-number citations go stale quickly, and are checked against the working tree even when it holds unrelated changes

Aperta
#2,083 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python, typescript

Direzione di ricerca

Start with skills/ce-compound/references/research.md Phase 1 and grounding-validation.md, then inspect validate-doc-claims.py to see how it handles paths and citation line suffixes. Trace how capture and refresh choose the tree used for code-behavior citations. Done when citations prefer symbol anchors where possible, verification uses and identifies the intended base tree, and refresh recognizes citations that still match the default branch.

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

Descrizione

ce-compound's capture step asks the drafter to "cite file:line alongside the claim" from the current tree (skills/ce-compound/references/research.md, Phase 1 draft step), and grounding-validation.md says code-behavior claims verify against the local working tree. This causes two problems.

  1. Line numbers go stale whenever lines are added or removed above them. In one repo using ce-compound, a single refresh pull request updated 70 learnings, most of them only to move line numbers, and a second branch existed just to update one learning's citations again. Neither change corrected anything a reader needed. The code had moved, and the numbers had not. validate-doc-claims.py strips :line suffixes before checking, so nothing flags a stale number until someone reads it.

  2. The working tree is not always the tree the learning will merge into. In a GitButler workspace, or any checkout with other unmerged work applied, the working tree includes changes that are not part of the learning's pull request. In one session, a capture wrote line numbers that were 4-7 lines off from the base branch, and a refresh investigation recommended "correcting" about ten citations that were right on the base branch to the working-tree values. On an ordinary feature branch this does not arise, because the learning merges with the code it cites.

Suggested changes:

  • Prefer symbol anchors (function, class, or config key names) over line numbers when citing code in a learning, and keep file:line for cases where no symbol identifies the spot.
  • When HEAD is not the default branch's tip, verify code-behavior citations against the merge base or the default branch, as validate-doc-claims.py already does for paths, and state which tree was used.
  • In refresh, do not classify a citation as drifted when it matches the default branch.
Lingua principale
TypeScript
Stelle
25.6k
Fork
2.1k
Merge medio
3h 57m
PR unite (30g)
170

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 EveryInc/compound-engineering-plugin

Tutte le issue di EveryInc/compound-engineering-plugin

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.