e453ad3602
Plugin README, marketplace README, and CONTRIBUTING.md were committed with pre-v1.6.0 content. Syncs all documentation with the actual v1.6.0 release: adds /ultraresearch-local section, updates agent count (19), command count (3), pipeline diagram, examples, and architecture tree. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
59 lines
2.4 KiB
Markdown
59 lines
2.4 KiB
Markdown
# Contributing to ultraplan-local
|
|
|
|
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 (`claude --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/ultraresearch-local.md` | The `/ultraresearch-local` slash command — research orchestration |
|
|
| `commands/ultraplan-local.md` | The `/ultraplan-local` slash command — planning orchestration |
|
|
| `commands/ultraexecute-local.md` | The `/ultraexecute-local` slash command — execution orchestration |
|
|
| `agents/*.md` | 19 specialized agents for research, exploration, review, and orchestration |
|
|
| `templates/plan-template.md` | Structured plan output format |
|
|
| `templates/research-brief-template.md` | Research brief format with triangulation and confidence |
|
|
| `templates/spec-template.md` | Spec file format |
|
|
| `templates/session-spec-template.md` | Session spec format for headless execution |
|
|
| `templates/headless-launch-template.md` | Launch script template |
|
|
|
|
The command files are the core. All logic lives in markdown.
|
|
|
|
## Testing locally
|
|
|
|
```bash
|
|
claude --plugin-dir /path/to/ultraplan-local
|
|
# Then in the session:
|
|
/ultraresearch-local <research question>
|
|
/ultraplan-local <describe a task>
|
|
/ultraexecute-local <path to plan>
|
|
```
|
|
|
|
Verify:
|
|
- `/ultraresearch-local`: Research agents spawn, brief written to `.claude/research/`
|
|
- `/ultraplan-local`: Exploration agents spawn in parallel, plan follows template, plan written to `.claude/plans/`, adversarial review runs
|
|
- `/ultraexecute-local`: Steps execute with verify + checkpoint per step
|