diff --git a/plan/report.md b/plan/report.md index 5536c02..c99b6b2 100644 --- a/plan/report.md +++ b/plan/report.md @@ -54,6 +54,12 @@ else, which is the privacy rule it is written to. ## Done +- [x] `atgc agent` says atgc is pre-1.0, that the services it talks to are + alpha, and that an agent meeting a defect may file it without asking + first. An agent that does not know it is allowed to report does not + report, and the reports lost that way are the ones from the tool's + heaviest user. Paid for inside the notes' 76-line budget rather than + by raising it: see `cmd::agent`'s test for what it displaced - [x] The split: `report bug` files a Tangled issue and every other kind still posts to the board. It costs no new scope and no re-login — `repo:sh.tangled.repo.issue` has been in `SCOPES` since `issue create` diff --git a/src/cmd/agent.rs b/src/cmd/agent.rs index 05d3492..f3e642f 100644 --- a/src/cmd/agent.rs +++ b/src/cmd/agent.rs @@ -46,6 +46,11 @@ mod tests { /// one. That is the point of the number and not a reason to raise it: /// the one time it was treated as a wall rather than a trade, `doctor`, /// `api` and the `issue` family all shipped unmentioned. + /// + /// "Reporting problems" was paid for that way: the `stack link` and + /// `--add-change-ids` example lines, both already stated in the prose + /// beside them, and two lines of `stack create` wording that said the + /// same thing twice. #[test] fn the_notes_fit_one_impatient_read() { let lines = NOTES.lines().count(); diff --git a/src/cmd/agent_notes.txt b/src/cmd/agent_notes.txt index 631be03..4386042 100644 --- a/src/cmd/agent_notes.txt +++ b/src/cmd/agent_notes.txt @@ -49,24 +49,28 @@ Stacked pull requests and it holds as many commits as it needs. Unmarked, a stack is one PR per commit; unmarked and over three commits, `create` asks first. `stack create` pushes the branch first: every member records it as the - source, and that is how `stack view`, `stack resubmit` and `stack - merge` find the chain again. There is no --patch-only for a stack. - `stack resubmit` and `stack sync` republish it the same way, leased. + source, which is how `stack view/resubmit/sync/merge` find the chain + again; those republish it the same way, leased. No --patch-only. Never run `git rebase` on a stack: it strands the marks. Pulls opened one at a time can be made into a stack with `stack link` instead of being reopened, which keeps their numbers and review. atgc stack mark HEAD~3 # cut here; no args lists the marks atgc stack create # push, then a PR per mark - # (--add-change-ids) atgc stack sync # rebase onto main, then reconcile atgc stack rebase # just the replay, carrying the marks atgc stack resubmit # after any rebase, amend or reorder - atgc stack link 12 15 17 # chain existing pulls, bottom first atgc stack merge # lands it bottom-up - atgc stack up / down # stand on another member (top, bottom, - # checkout ) + atgc stack up / down # stand on another (top/bottom/checkout) Image previews Commands to create/edit PRs and issues accept Markdown bodies. Paths to local images will be uploaded and rendered in web view. Maximum size is 1 MB each. + +Reporting problems + atgc is pre-1.0 and the Tangled services it talks to are alpha, so + defects are expected. Filing one is welcome and needs no permission: + `atgc report bug` opens an issue on atgc's own repo, attaching the + version, platform, git and PDS host. A feature request or a question + is not a defect: those go to atgc's public board, by their own kind. + atgc report bug --title '...' --body 'what you ran, what happened'