Skip to content

Commit 1137dc0

Browse files
committed
docs: require README + SKILL.md updates for every user-facing feature; fix stale Quick Start counts
1 parent d2afe7c commit 1137dc0

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

‎AGENTS.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ Background job runner for AI coding agents with **live session wake-to-act** on
1010

1111
```bash
1212
# Verify everything works
13-
npm test # smoke tests (node plugin/bgrun-wake.test.js) — expect 19/19 pass
13+
npm test # smoke tests (node plugin/bgrun-wake.test.js) — expect 39/39 pass
1414
npm run lint # shellcheck + node --check — expect exit 0
15-
npm pack --dry-run # verify tarball contents (expect 12 files, @stablekernel/opencode-bgrun@0.1.2)
15+
npm pack --dry-run # verify tarball contents (expect 14 files, @stablekernel/opencode-bgrun@0.1.2)
1616
```
1717

1818
## Project Structure
1919

2020
```
2121
bin/ # Shell CLI scripts (bgrun, bgstatus, bgtail, bgclean, _bgrunner.sh)
2222
plugin/
23-
bgrun-wake.js # OpenCode plugin — registers the bgrun TOOL, runs the wake poller
24-
bgrun-wake.test.js # Standalone smoke tests (19 tests, no npm deps in runner)
23+
bgrun-wake.js # OpenCode plugin — registers bgrun + bgclean MCP tools, runs the wake poller
24+
bgrun-wake.test.js # Standalone smoke tests (39 tests, no npm deps in runner)
2525
skill/run-bg/SKILL.md # Agent-facing skill for consuming this tool
2626
install.sh # Dev/clone install: symlinks bin+plugin+skill + --cli-only mode
2727
uninstall.sh # Removes install.sh-created symlinks + --cli-only mode
@@ -125,6 +125,7 @@ All commits MUST be signed (`commit.gpgsign=true`, key `824AA8A544E8AB33`, `lloy
125125
3. **NEVER publish a version that doesn't have a matching signed git tag** — the `release.yml` version-consistency guard enforces this, but also enforce it manually.
126126
4. **NEVER modify generated files** in `node_modules/`.
127127
5. **NEVER force-push `main`** — use admin bypass via normal `git push` (bypass is already enabled for admins).
128+
6. **NEVER add a user-facing feature without updating both `README.md` and `skill/run-bg/SKILL.md`** — README is the human reference; SKILL.md is what agents read. Both must stay in sync with the implementation. Shell commands, MCP tools, env vars, flags, and default values all count. Internal implementation details (slug format, sidecar file structure) do not need to be documented.
128129

129130
## Key Design Decisions (don't relitigate without reading these)
130131

0 commit comments

Comments
 (0)