mirror of https://github.com/AgentSeal/codeburn.git synced 2026-05-17 03:56:45 +00:00

Add CONTRIBUTING.md, docs/architecture.md, and per-provider docs (#284 )

Document the contributor onboarding path:
- CONTRIBUTING.md: setup, npm scripts, coding conventions, PR process,
  the block-claude-coauthor enforcement, and the five providers without
  test coverage today (claude, gemini, goose, qwen, antigravity).
- docs/architecture.md: 12-command CLI surface, parser pipeline, three
  cache layers, 14 optimize detectors, and the mac / gnome / build
  layouts with cited line numbers.
- docs/providers/: one file per provider (17 providers plus the shared
  vscode-cline-parser helper). Each covers data path, storage format,
  caching, dedup key, quirks, and a "when fixing a bug here" checklist.

Also fix two pre-existing documentation issues surfaced while writing
the new docs:
- RELEASING.md claimed GitHub Actions auto-publishes the CLI when a
  v* tag is pushed. There is no such workflow; CLI publishing is
  manual via npm publish. Updated the CLI section to reflect reality
  and kept the menubar (mac-v* tag) automation accurate.
- .gitignore had CLAUDE.md unanchored, which on case-insensitive
  filesystems also matched docs/providers/claude.md. Anchored to
  /CLAUDE.md so the root-level memory file stays ignored without
  affecting subdirectory docs.

All cited file paths, line numbers, function names, and test counts
were verified against current code (41 test files, 558 tests passing).

2026-05-09 18:39:41 -07:00

1.9 KiB

Raw Blame History

Copilot

GitHub Copilot Chat (CLI and VS Code extension transcripts).

Source: src/providers/copilot.ts
Loading: eager (src/providers/index.ts:3)
Test: tests/providers/copilot.test.ts (401 lines)

Where it reads from

Two locations. Both are walked on every run; results merge.

Legacy CLI sessions: ~/.copilot/session-state/
VS Code transcripts: ~/Library/Application Support/Code/User/workspaceStorage/<hash>/GitHub.copilot-chat/transcripts/ and equivalents on Windows / Linux

Storage format

JSONL in both locations, but the schemas differ. The parser switches by detecting which schema the first event uses (copilot.ts:83-159 for legacy, copilot.ts:215-293 for transcripts).

Caching

None at the provider level.

Deduplication

Per messageId in both formats (copilot.ts:118 for legacy, copilot.ts:245 for transcripts).

Model inference

Copilot does not always tag the model on each message. The parser infers it from the tool-call ID prefix:

Prefix	Inferred model family
`toolu_bdrk_`, `toolu_vrtx_`, `tooluse_`, `toolu_`	Anthropic
`call_`	OpenAI

See copilot.ts:176-213.

Quirks

toolRequests can be missing or non-array on older sessions; the parser guards against that (copilot.ts:126, :260).
When outputTokens is missing the parser falls back to char-counting (CHARS_PER_TOKEN = 4, copilot.ts:252-254).
A single chat may be mirrored across both legacy and transcript paths if the user upgraded; the dedup messageId collision handles this.

When fixing a bug here

Determine which schema reproduces the bug. The two parsers share little code on purpose; do not unify them unless you understand both formats.
If the model is misidentified, look at the tool-call ID prefix list and consider whether a new prefix should be added.
New fixtures go under tests/fixtures/copilot/ and are referenced from tests/providers/copilot.test.ts.

1.9 KiB Raw Blame History