[awf] ledger guidance: comment-backed storage missing from agent authoring guide

Aperta Adatta ai principianti
#11,612 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
72/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
markdown, yaml
Ambito
documentation

Direzione di ricerca

Inizia leggendo .github/aw/ledger.md e annota ogni affermazione specifica di Git (branch, commit, clone/push, compattazione, limite di 1024 file), poi confrontala con lo schema supportato dai commenti in pkg/parser/schemas/main_workflow_schema.json (vedi le voci tools.ledger.<name>.storage: comment-memory e tools.comment-memory) e con la sezione trust/queue/capacity di docs/src/content/docs/specs/repo-memory-ledger-specification.md. Delimita le affermazioni su Git, aggiungi un esempio funzionante supportato dai commenti con la sua configurazione target richiesta e i limiti per backend, e nota che cambiare storage non migra la cronologia. Fatto quando la guida compila come configurazione documentata e il controllo di guidance aggiunto rifiuta le affermazioni secondo cui tutti i ledger usano un branch Git.

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

Descrizione

awf-triage

Problem

The agent authoring guide .github/aw/ledger.md presents Git branch storage (ledgers/<name> branch, commits, clone/push, compaction, 1024-file limit) as universal. Since tools.ledger.<name>.storage: comment-memory was added (commit 910cd8c), agents may choose or describe the wrong backend.

Context

Original issue: github/gh-aw#77571 (feature ID ledger.storage-comment-memory).

Root Cause

The guide was written before the comment backend existed and was not updated. Its Git-specific statements are not scoped to Git-backed ledgers. The schema (pkg/parser/schemas/main_workflow_schema.json) and human docs already cover comment storage, so the gap is limited to agent-facing guidance.

Proposed Solution

  • P1: Update .github/aw/ledger.md with a valid comment-backed example, the required tools.comment-memory target configuration, deferred persistence, and per-backend limits (no compaction, smaller history).
  • P2: Explain the Git vs. comment choice. State that changing storage does not migrate existing ledger history. Link docs/src/content/docs/specs/repo-memory-ledger-specification.md for trust, queue, and capacity limits.
  • P2: Add a guidance check that compiles the documented comment-backed configuration and fails on claims that all ledgers use a Git branch.

Generated by Firewall Issue Dispatcher · copilot · routed: haiku55 xhigh · ~2 AIC · ⊞ 3K · ◷

Lingua principale
TypeScript
Stelle
165
Fork
84
Merge medio
5h 57m
PR unite (30g)
390

Preparare l'ambiente

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 github/gh-aw-firewall

Tutte le issue di github/gh-aw-firewall

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.