Commit 07053cb
[GRV-36]: Document human-handoff-linear (#53)
## Summary
- Reposition `human-handoff-linear` in the root README as an independent
local Linear workflow primitive with dry-run-first setup commands.
- Rework the package README into a self-contained guide covering
install, auth, `doctor`, `setup`, `sync-template`, and
`bootstrap-project` usage.
- Clarify current API-key local setup versus a future hosted OAuth /
Linear Integration Directory app.
- Add package keywords and strengthen CLI help smoke checks for
README-referenced command and option output.
## Acceptance Criteria
- Root README lists `human-handoff-linear` with value proposition and
setup commands: done.
- Package README documents install, auth, `doctor`, `sync-template`,
`setup`, and `bootstrap-project`: done.
- Docs explain API-key local setup versus future OAuth / Integration
Directory app: done.
- Docs include minimal Linear setup walkthrough and dry-run-first
recommendation: done.
- `package.json` metadata includes repository directory, license,
engine, bin, files, and keywords: done.
- Tests / smoke checks cover command help output referenced by docs:
done.
## Verification
- `npm --workspace human-handoff-linear test` - passed
- `npm test` - passed
- `git diff --check` - passed
## CLI Scorecard
Surface: `human-handoff-linear` CLI help and documented command flow.
Score: 86 / 100.
Worst findings:
- Long Linear API calls name their action and end with outcomes, but do
not estimate rough duration for unusually slow workspaces.
- There is no explicit TTY/non-TTY formatting branch beyond the absence
of spinners/color and line-based output.
- Help text is complete but dense; deeper examples live in README rather
than inline help.
Skipped checks: none.
Co-authored-by: riddim-developer-bot <developer-bot@riddimsoftware.com>1 parent 91eaa58 commit 07053cb
4 files changed
Lines changed: 182 additions & 143 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
42 | 31 | | |
43 | 32 | | |
| 33 | + | |
44 | 34 | | |
45 | 35 | | |
46 | 36 | | |
| |||
0 commit comments