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

Đang mở Phù hợp với người mới
#11,612 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, yaml
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc đọc .github/aw/ledger.md và ghi chú mọi khẳng định đặc thù của Git (branch, commits, clone/push, compaction, giới hạn 1024 tệp), sau đó so sánh với schema được hậu thuẫn bởi comment trong pkg/parser/schemas/main_workflow_schema.json (xem các mục tools.ledger.<name>.storage: comment-memory và tools.comment-memory) và phần trust/queue/capacity của docs/src/content/docs/specs/repo-memory-ledger-specification.md. Giới hạn phạm vi các phát biểu về Git, thêm một ví dụ hoạt động được hậu thuẫn bởi comment với cấu hình đích bắt buộc và giới hạn theo từng backend, và lưu ý rằng việc chuyển storage không di trú lịch sử. Hoàn thành khi hướng dẫn biên dịch như config được ghi tài liệu và kiểm tra guidance được thêm vào từ chối các khẳng định rằng mọi ledger đều dùng một Git branch.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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 · ◷

Ngôn ngữ chính
TypeScript
Star
165
Fork
84
Merge trung bình
5 giờ 57 phút
Pull request đã merge (30 ngày)
390

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/gh-aw-firewall

Tất cả issue của github/gh-aw-firewall

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.