voyage/CONTRIBUTING.md
Kjell Tore Guttormsen 8295601965
chore(cleanup): remove the June trials, orchestrator docs, dormant agent, caller-less code and the fix-round chain
R4-R7 of the cleanup list (decision 188): the June trial docs and
fixtures, the three orchestrator reference docs, the dormant
synthesis-agent, code with no caller (project-discovery, bash-normalize,
fidelity-diff, test-census, the next-session prompt validator, arm B and
the --workflow flag) and the fix-round chain. Living docs repointed; the
reasons for in-session orchestration and the all-opus pin are now written
in docs/architecture.md and docs/profiles.md.

New tests/lib/living-paths.test.mjs: living tracked text names only
plugin paths that exist (seen red with 22 dead pointers before this
commit). docs/T1-cc26-delegated-orchestration.md and
lib/review/gold-scorer.mjs stay until R-b: the frozen end-state registry
names them.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-07 12:51:54 +01:00

2.3 KiB

Contributing to trekplan

This is a solo project. Issues are welcome. PRs may be considered but are not expected.

Reporting bugs

Open an issue with:

  • Plugin version (from .claude-plugin/plugin.json)
  • Claude Code version
  • What you did, what you expected, what happened instead
  • Whether it fails consistently or occasionally

Suggesting features or improvements

Open an issue describing:

  • The problem you ran into
  • What you think would solve it
  • Any alternatives you considered

Design principles

Changes to this plugin must preserve:

  • Pure markdown — no scripts, no dependencies, no platform-specific code
  • Cross-platform — must work identically on Mac, Linux, and Windows
  • Cost-aware — Sonnet for exploration, Opus only for planning
  • Privacy-first — never read files outside the repo, never log secrets
  • Honest — if a task is trivial, say so instead of inflating the plan

Architecture

File Purpose
.claude-plugin/plugin.json Plugin manifest
commands/trekresearch.md The /trekresearch slash command — research orchestration
commands/trekplan.md The /trekplan slash command — planning orchestration
commands/trekexecute.md The /trekexecute slash command — execution orchestration
agents/*.md 20 agent files, all spawnable, for research, exploration, review and execution
templates/plan-template.md Structured plan output format
templates/research-brief-template.md Research brief format with triangulation and confidence
templates/session-spec-template.md Session spec format for a session the user opens

The command files are the core. All logic lives in markdown.

Testing locally

Start a Claude Code session yourself with this checkout loaded as a local plugin (Claude Code's plugin-directory option; see its plugin docs). Voyage never starts a session for you. Then, in that session:

/trekresearch <research question>
/trekplan <describe a task>
/trekexecute <path to plan>

Verify:

  • /trekresearch: Research agents spawn, brief written to .claude/research/
  • /trekplan: Exploration agents spawn in parallel, plan follows template, plan written to .claude/plans/, adversarial review runs
  • /trekexecute: Steps execute with verify + checkpoint per step