bkinnightskytw
/
code_work_spawner
1
0
Fork 1
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs: compress README.md

This commit is contained in:
insleker 2026-04-05 15:53:42 +08:00
parent c9fd672a04
commit 0427f29650
1 changed files with 12 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@ -2,29 +2,17 @@
GitHub issue thread assistant with an Agent Orchestrator style YAML config. GitHub issue thread assistant with an Agent Orchestrator style YAML config.
The app polls configured GitHub repositories with `gh`, reads issue threads and It polls configured GitHub repositories with `gh`, reads issue threads, and
issue comments, and uses configured CLI responders such as `codex`, uses CLI responders such as `codex`, `opencode`, or `copilot-cli` to decide
`opencode`, or `copilot-cli` to reply when: when to reply. It supports multi-repo config, responder fallback chains, and
optional Discord webhook notifications.
- a user explicitly mentions the assistant ## Highlights
- a new comment changes the thread enough that the responder decides a reply is
useful
It supports multi-repo configuration, responder fallback chains. - Poll GitHub issues across multiple repositories
It can also emit non-fatal Discord webhook notifications for issue assistant - Trigger replies from mentions or meaningful thread updates
events such as mentions, replies, no-reply decisions, and responder failures. - Run planning and bug-verification flows in isolated worktrees
- Send optional Discord notifications for assistant events
## Features
- Agent Orchestrator style YAML config with `defaults` and `projects`
- Multiple repositories in one process
- Comment-triggered issue assistance
- Planning / architecture guidance in issue threads
- Bug verification flows in isolated temporary git worktrees
- CLI-based responder fallback chain
- Optional Discord webhook notifications
- Durable state with `drift` + SQLite
- BDD-style tests using `package:test` with Given / When / Then wording
## Requirements ## Requirements
@ -35,11 +23,9 @@ events such as mentions, replies, no-reply decisions, and responder failures.
## Config ## Config
Create a local `agent-orchestrator.yaml` and follow [`/examples/README.md`](examples/README.md) as a starting point. Create a local `agent-orchestrator.yaml` and use
[`examples/README.md`](examples/README.md) plus
Notification config lives under `defaults.issueAssistant.notifications` or [`examples/simple-github.yaml`](examples/simple-github.yaml) as the reference.
`projects.<key>.issueAssistant.notifications`. Supported events are
`mention_detected`, `reply_posted`, `no_reply`, and `responder_failed`.
Generate a starter config: Generate a starter config:
@ -86,13 +72,6 @@ dart analyze
dart test dart test
``` ```
All Dart tests under `test/` must follow the repo's Gherkin doc-comment format:
- `group(...)` has a `Feature` doc block above it
- `test(...)` has a `Scenario` doc block above it
- runtime names stay plain, without `Feature:` or `Scenario:` prefixes
- test bodies include `Given` / `When` / `Then` inline comments
## ref ## ref
[agent-orchestrator](https://github.com/ComposioHQ/agent-orchestrator) [agent-orchestrator](https://github.com/ComposioHQ/agent-orchestrator)