Skip to content

feat(setup): add pairing family first-run welcome guide - #1706

Merged
potiuk merged 6 commits into
apache:mainfrom
KatalKavya96:docs/pairing-welcome-guide
Oct 19, 2026
Merged

potiuk merged 6 commits into
apache:mainfrom
KatalKavya96:docs/pairing-welcome-guide

Conversation

@KatalKavya96

Copy link
Copy Markdown
Contributor

Summary

  • Add a first-run welcome guide for the pairing family, covering self-review and multi-agent-review, so newcomers can understand the review workflow and get started with plain-language requests.
  • Document optional configuration, personal installation versus project adoption, read-only safety boundaries, and workflow customization. Link the guide from docs/pairing/README.md.
  • Add welcome regression tests and a preflight-floor evaluation fixture using the actual self-review surface hash. Regenerate the general welcome report and update evaluation case counts.

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other: Setup-preflight welcome guide, regression tests, and generated evaluation fixture

Test plan

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:
    • pytest tests/test_welcome.py — 51 tests passed before the additional family assertion.
    • render-preflight-fixtures.py --check — passed.
    • Welcome guide rendered successfully with the shared footer.
    • git diff --cached --check — passed.
    • Workspace pytest, Ruff check, Ruff format, mypy, documentation checks, and validators passed through prek.

RFC-AI-0004 compliance

  • HITL — any new mutation is gated on explicit user confirmation
  • Sandbox — no new unrestricted host access; network reach declared in the adapter
  • Vendor neutrality — placeholders (<PROJECT>, <tracker>, <upstream>, <security-list>) used in all skill / tool prose (the check-placeholders prek hook is the mechanical gate)
  • Conversational + correctable — agentic-override path documented if behaviour is adopter-tunable
  • Write-access discipline — no autonomous outbound messages; drafts only, sent on confirmation
  • Privacy LLM — private content does not reach a non-approved LLM; redactor invoked where needed

No runtime behavior, external write permissions, or security controls are changed. Both pairing skills remain read-only.

Linked issues

Closes #1661

Refs #1654

Notes for reviewers (optional)

AI tooling disclosure: AI assistance was used for repository analysis, patch drafting, and review. Changes were applied and validated locally by the contributor.

@KatalKavya96

Copy link
Copy Markdown
Contributor Author

Hi @potiuk,

I've implemented the Pairing family welcome guide for #1661, following the established pattern from #1653 and the merged #1669.

I've included both pairing skills, the README link, first-run evaluation fixture, and regression tests. All repository-wide checks passed locally with prek run --all-files.

Thanks!

@github-actions github-actions Bot added family:setup setup-* skills family:tools tools/* family:docs Docs, MISSION.md, READMEs capability:platform Framework / agent substrate skills (install, verify, doctor, override, status, setup bootstrap) family:pairing pairing skills substrate:framework-dev Tool substrate: build / validate / eval the framework itself substrate:setup Tool substrate: adopter-side setup state resolved at runtime (lock parsing, floors, fingerprints) labels Oct 19, 2026

@Kaap10 Kaap10 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @KatalKavya96 for putting this together!

Tested locally — the welcome guide content is crisp, the surface hash matches self-review accurately, and both regression tests and preflight fixture checks pass cleanly.

Left one inline suggestion on docs/pairing/README.md regarding layout consistency with other family READMEs (security, utilities, contributor-growth). Other than that, everything looks solid!

Comment thread docs/pairing/README.md Outdated
KatalKavya96 and others added 4 commits October 19, 2026 20:21
…ig bullet

`/magpie-setup:setup config` configures the installed skills for the
user; it installs nothing, so the guide now says "Configure it for
yourself". The "Adversarial reviewers" bullet pointed at
`adversarial-review.md`, which neither pairing skill reads, and called
the passes "three independent review passes", which holds only for
multi-agent-review, so it is dropped. The case-11 fixture that embeds
the guide is re-rendered.

Generated-by: Claude Opus 5
…706-fixup

Generated-by: Claude Opus 5

# Conflicts:
#	tools/setup-preflight/tests/test_welcome.py
#	tools/skill-evals/evals/setup/README.md
#	tools/skill-evals/evals/setup/preflight-floor/fixtures/case-9-first-magpie-run/report.md

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adds the pairing-family first-run welcome guide for self-review and multi-agent-review, matching the utilities guide file for file; the scope options it lists exist in both skills and the fixture's self-review surface hash is correct.

I pushed two commits rather than send this round again:

  • d788b60 — wording. "Install for yourself with /magpie-setup:setup config" now reads "Configure it for yourself …": config configures the skills you already installed and installs nothing. I also dropped the "Adversarial reviewers" bullet: neither pairing skill reads adversarial-review.md, and "three independent review passes" holds only for multi-agent-review (self-review is a single pass), so it would have pointed newcomers at a file this family never uses.
  • 2c1c66f — merge of main. #1708 (the mentoring guide) landed first and claimed the same slots, so the pairing fixture moves to case-12-pairing-first-run, the setup case counts go to 132, the test lists carry both families, and the case-9 report is re-rendered with both guides in its "More guides" list.

Thanks for the guide!


This review was drafted by an AI-assisted tool and
confirmed by an Apache Magpie maintainer. The maintainer
approving this PR has read the findings and signed off. If
something feels off, please reply on the PR and a maintainer
will follow up.

More on how Apache Magpie handles maintainer review:
Contributing guide.

@potiuk
potiuk merged commit 34c77a9 into apache:main Oct 19, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

capability:platform Framework / agent substrate skills (install, verify, doctor, override, status, setup bootstrap) family:docs Docs, MISSION.md, READMEs family:pairing pairing skills family:setup setup-* skills family:tools tools/* substrate:framework-dev Tool substrate: build / validate / eval the framework itself substrate:setup Tool substrate: adopter-side setup state resolved at runtime (lock parsing, floors, fingerprints)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Welcome guide: pairing family

3 participants