Release v1.2.1: documentation updates (bb-driven agent conventions)#21
Conversation
…25 part B) Part B of #25 — the upstream-template + README half (Part A populated the local ~/.claude/agents/bitbucket.md from bb discovery; that's machine-local and not in this repo). agents/bitbucket.md (generic template): - Rename "Project-specific conventions" → "Per-workspace conventions" and restructure from a single flat block to a per-workspace template (one block per workspace slug + a top-level default for repo-less commands), matching the multi-workspace resolution model shipped in v1.2.0. - Add the read-only `bb` discovery survey (workspaces / repo / pipelines / branches / vars / pr) that derives every field, so populating the section is a mechanical survey, not a from-memory guess. - New operating principle #6 "Populating conventions from bb": when delegated work in a workspace with no block yet, the agent runs the survey and proposes a filled-in block for confirmation rather than interrogating the user. Real values → local copy only, never upstream. README (agent-install section): - Step 2 now shows the bb discovery commands to populate the per-workspace blocks instead of "fill in from memory". - Renamed all "Project-specific conventions" references to "Per-workspace conventions"; updated the with-agent comparison-table row to "reads or bb-discovers and proposes" the block. No code changes — docs only. 388 pytest tests still pass.
Two spots the rename missed (cosmetic terminology drift): - README:322 — "project-conventions checklist for tracking per-workspace defaults" → "per-workspace conventions block for tracking each workspace's defaults" (no longer a flat checklist; it's a per-workspace template now). - README comparison-table row label "Project conventions" → "Per-workspace conventions" (its value cell was already updated). Docs-only, no code touched.
1. The "Main branch = default destination branch" survey hint is imperfect for GitFlow repos — bb repo surfaces mainbranch, but a GitFlow workspace (including this repo: mainbranch=main, PRs target develop) takes PRs against a different branch. Added a one-line "verify the PR base — GitFlow repos target develop" caveat in the conventions-section survey, operating-principle #6, and the README install step. 2. Aligned operating-principle #6's survey list with the conventions-section list (added the missing `bb -w <ws> repos` step). Docs-only; non-blocking polish on an already-ship-ready PR.
Completes the round-2 nit fix — the prior commit applied the caveat to agents/bitbucket.md but the README edit raced a concurrent file change and was dropped. Mirrors the same 'verify PR base; GitFlow repos target develop' note in the README install step.
|
Claude finished @daniel-pittman's task in 3m 34s —— View job Code Review — PR #21 (Release v1.2.1, docs-only)
Scope note: this PR is already MERGED and the branch I'm on is a shallow checkout of VerdictSolid docs-only patch release. The "Project-specific conventions" → "Per-workspace conventions" rename is complete — I grepped the repo and found no stale section-name references (the lone Findings (minor)1.
But 2. README survey omits the 3. Nits (optional, non-blocking)
Nothing here blocks the release; the rename, survey, and GitFlow caveat all land cleanly. Items 1 and 2 are quick wins for a follow-up to |
v1.2.1 — documentation release
Patch release to get the v1.2.0-era documentation onto
mainand into a published release. v1.2.0 shipped the multi-workspace code; this carries the docs that landed ondevelopafterward (PR #20 / #25 part B) but never made it into a tagged release.What's included (docs-only — no code changes since v1.2.0)
agents/bitbucket.md: "Project-specific conventions" → "Per-workspace conventions" restructure (per-workspace blocks keyed by slug), the read-onlybbdiscovery survey for populating them, new operating-principle Phase 4.5: git_ops — git-context wrappers for the MCP agent #6 ("the agent runs the survey and proposes a block rather than asking the user to recite defaults"), and a GitFlow PR-base caveat.README.md: agent-install step now shows thebbdiscovery commands; "Per-workspace conventions" rename throughout; GitFlow PR-base caveat.Test plan