docs(bitbucket): clarify partial bridge coverage#748
Conversation
|
Hi @potiuk , I opened this small follow-up PR to address the two clarification points from the initial Bitbucket bridge review. This keeps Bitbucket under I also clarified that repository metadata reads are currently Bitbucket PR workflow context, not a complete
|
|
I ran teh review tool over this: Thanks for the follow-up, this is a clear improvement and the operation-coverage matrix matches the actual CLI surface (repo get, pr list-open, pr get), which is exactly the precision #606 needs. One thing before this lands: Coverage: partial-read-only and the "complete/selectable backend" wording introduce a coverage vocabulary that isn't defined anywhere yet. It's not in labels-and-capabilities.md or the registry authoring doc, and no other tool README uses a Coverage: field. Could we either define the token once in the capability taxonomy and link to it, or keep it as plain prose? Otherwise it reads as a status the next partial adapter has to match with no spec behind it. Two small nits: partial-read-only is backticked as a token in some places and bare prose in others (registry.md, vendor-neutrality.md); and the tools/bitbucket/README.md intro still says "read-only foundation" right before the new "partial read-only profile" sentence. |
4561d04 to
45da792
Compare
|
@justinmclean Thanks, that makes sense. I updated the PR to define I also cleaned up the Bitbucket README intro so it no longer says “read-only foundation” immediately before the partial coverage wording. It now consistently describes the bridge as a I rebased the branch onto the latest |
potiuk
left a comment
There was a problem hiding this comment.
Reviewed — this is exactly the right vendor-neutrality hygiene: documenting the Bitbucket bridge as partial-read-only so it isn't advertised as a complete/selectable backend, rather than over-claiming completeness. Clean and consistent across the capability, registry, and vendor-neutrality docs.
A couple of things I checked specifically:
- The
docs/vendor-neutrality.mdedits stay in the hand-written prose (the six-axes narrative + the delivery table), not the generated counts block, so there's no clash with the regeneration hook. CI confirms. - Keeping
contract:change-request+ aCoverage:qualifier, rather than inventing a separatecontract:change-request-readcapability, is the right call — it avoids capability proliferation while still being honest about coverage.
One tiny, non-blocking nit: the "Coverage qualifiers" section describes the qualifier as sitting "next to a capability", while the bitbucket README declares **Coverage:** as a standalone top-level field — not worth holding the merge for.
Nice, careful work — thanks!
Summary
Coverage: partial-read-onlyundercontract:change-request, so it is not presented as a complete/selectable backend yet.~/.config/apache-magpie/bitbucket/and aligns Bitbucket wording across capability, registry, and vendor-neutrality docs.Type of change
.claude/skills/<name>/) — eval fixtures updated belowtools/<system>/*.md)tools/*/withpyproject.toml)docs/,README.md,CONTRIBUTING.md)projects/_template/)prek, workflows, validators)Test plan
prek run --all-filespassesuv run pytest/ruff check/mypypasses(
PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)(a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
RFC-AI-0004 compliance
partial-read-onlyand excluded from complete/selectable backend wording until the full contract is implemented.Linked issues
Refs #606
Notes for reviewers (optional)
This follows up on the maintainer feedback from the initial Bitbucket bridge PR.
The main clarification is to keep
contract:change-requestas the capability while addingCoverage: partial-read-only, rather than introducing a separate capability such ascontract:change-request-read. The README now states that partial adapters may implement named contract verbs but do not satisfy the complete contract and must not be advertised as complete/selectable backends.It also clarifies that repository metadata reads are currently Bitbucket PR workflow context, not a complete
contract:source-controlbackend, and thatcontract:trackerremains absent until Bitbucket issue operations or linked Jira handoff coverage exist.