Repository navigation
docs(agents): attach PR images with gh --attach and adopt the Pwr family's PR conventions - #11
Merged
Merged
Conversation
…ily's PR conventions Ports the PR, screenshot, PwrAgent-thread and agent-file conventions from PwrRoute, PwrAgent and PwrGit. A previous agent hosted screenshots on a side branch because it believed gh could not upload them; the gh --attach procedure is now linked from the top of AGENTS.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Brings PwrDisk's agent guidance up to the Pwr family's conventions. Above all, PR screenshots and videos are now attached with
gh --attach. A previous agent here believedghcould not upload images and hosted them on a side branch, so the rule is linked from the top ofAGENTS.md.What changed
AGENTS.md: a pointer under the intro ("Opening a PR? Read Pull requests first"), and three new sections at the end. The working contract, house rules, invariants and the "where changes belong" table are untouched.gh --attach, never a side branch, gist or commit; before/after screenshots of a contrived tree; scans are private data (user names in paths, volume names, the chooser's mounts and SSH hosts), and anything not contrived goes to the operator first; Conventional Commit titles with PwrDisk scopes and the(port of tobi/disktree#N)suffix the fork's ports already use; noCHANGELOG.mdedits in feature PRs; push only topwrdrvr/PwrDisk.notifyOn: ["merged", "closed"]; deferred work goes on anadd_todocard, not into the PR body; reuse an open PwrDisk window.AGENTS.mdthat needs it, long procedures go indocs/, and everyAGENTS.mdhas aCLAUDE.mdsymlink.CLAUDE.md: a symlink toAGENTS.md, as in PwrGit, PwrRoute and PwrAgent.docs/pr-screenshots.md(new): how to make screenshots without leaking a real disk, and the full--attachprocedure.Fixturesso the status bar doesn't show the real volume. The app is run aspwrdisk <root>, which skips the chooser, and "before" comes frommainin a second worktree.--attach; fetching the live body withgh pr view <n> --json body -q .bodybefore every later edit; a loop that checks each image link is auser-attachmentsURL that returns HTTP 200 with the right size.Ported from
gh --attach, the three silent failures, the link check, the routes table's shapedocs/pr-screenshots.md, PwrAgentAGENTS.md› Pull RequestsAGENTS.md, full procedure indocs/CHANGELOG.mdin feature PRs; release prep writes itnotifyOn: ["merged", "closed"]add_todocardsCLAUDE.md → AGENTS.md, smallest scope, procedures indocs/Left out
cargo xtask lintstill runs locally. Only thenotifyOnwatch rule came over.Reconcile with #8
#8 adds
CHANGELOG.md, and itsdocs/releasing.mdsays to "moveCHANGELOG.md's Unreleased entries" under the version heading. This PR says feature PRs don't edit the changelog and the release-prep PR writes the section. The two fit if release prep writes the entries and then moves them, but whichever PR lands second should makereleasing.mdsay who writes them. The new sections sit at the end ofAGENTS.md, away from the Commands block and table rows #8 edits, so the two should merge cleanly.Verified
cargo xtask lintpasses. This PR only changes docs.