You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@magpie.apache.org by "KatalKavya96 (via GitHub)" <gi...@apache.org> on 2026/10/19 11:04:27 UTC

[PR] feat(setup): add pairing family first-run welcome guide [magpie]

KatalKavya96 opened a new pull request, #1706:
URL: https://github.com/apache/magpie/pull/1706

   <!-- SPDX-License-Identifier: Apache-2.0
        https://www.apache.org/licenses/LICENSE-2.0 -->
   
   ## 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)
   - [x] Documentation (`docs/`, `README.md`, `CONTRIBUTING.md`)
   - [ ] Project template (`projects/_template/`)
   - [x] CI / dev loop (`prek`, workflows, validators)
   - [x] Other: Setup-preflight welcome guide, regression tests, and generated evaluation fixture
   
   ## Test plan
   
   - [x] `prek run --all-files` passes
   - [x] 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>/`)
   - [x] 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)
   - [x] 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
   - [x] **Vendor neutrality** — placeholders (`<PROJECT>`, `<tracker>`, `<upstream>`, `<security-list>`) used in all skill / tool prose (the `check-placeholders` prek hook is the mechanical gate)
   - [x] **Conversational + correctable** — agentic-override path documented if behaviour is adopter-tunable
   - [x] **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)
   
   - Follows the established first-run welcome guide pattern from #1653 and merged #1669.
   - Reuses the existing shared `sections/welcome.md` rules and generated footer; no additional per-family rules section or production logic changes are needed.
   - The new evaluation fixture uses `self-review` with `surface_hash: sha256:ea0a2e29bb2aa0e0`.
   - Covers both pairing skills in family discovery tests and validates first-run ordering, guide rendering, and footer substitution.
   - The generated fixture and documentation counts are updated consistently.
   
   **AI tooling disclosure:** AI assistance was used for repository analysis, patch drafting, and review. Changes were applied and validated locally by the contributor.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] feat(setup): add pairing family first-run welcome guide [magpie]

Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #1706:
URL: https://github.com/apache/magpie/pull/1706


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] feat(setup): add pairing family first-run welcome guide [magpie]

Posted by "KatalKavya96 (via GitHub)" <gi...@apache.org>.
KatalKavya96 commented on code in PR #1706:
URL: https://github.com/apache/magpie/pull/1706#discussion_r4315316819


##########
docs/pairing/README.md:
##########
@@ -54,6 +54,8 @@ happens, no comment is posted, and the working tree is never mutated.
 
 ## Install & first runs
 
+First time using these skills? See the [Pairing welcome guide](../../plugins/magpie-setup/skills/setup/setup_preflight/guides/pairing.md) for a one-minute tour of the review workflow and example requests.
+

Review Comment:
   Thanks @Kaap10 for reviewing and testing the PR!
   
   I've updated the Pairing README to follow the same welcome-guide introduction layout as the other family READMEs, using your suggested wording and placement.
   
   Re-ran the repository checks locally and pushed the update. Thanks for catching the consistency issue!



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] feat(setup): add pairing family first-run welcome guide [magpie]

Posted by "KatalKavya96 (via GitHub)" <gi...@apache.org>.
KatalKavya96 commented on PR #1706:
URL: https://github.com/apache/magpie/pull/1706#issuecomment-6265744801

   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!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] feat(setup): add pairing family first-run welcome guide [magpie]

Posted by "Kaap10 (via GitHub)" <gi...@apache.org>.
Kaap10 commented on code in PR #1706:
URL: https://github.com/apache/magpie/pull/1706#discussion_r4314427249


##########
docs/pairing/README.md:
##########
@@ -54,6 +54,8 @@ happens, no comment is posted, and the working tree is never mutated.
 
 ## Install & first runs
 
+First time using these skills? See the [Pairing welcome guide](../../plugins/magpie-setup/skills/setup/setup_preflight/guides/pairing.md) for a one-minute tour of the review workflow and example requests.
+

Review Comment:
   To keep the documentation layout completely consistent with all other family READMEs (`docs/security/README.md`, `docs/utilities/README.md`, `docs/contributor-growth/README.md`), consider removing this 1-liner here and placing the standardized 4-line block right above `### Before the first run`:
   
   ```markdown
   The first pairing skill you run opens with a one-minute
   [welcome guide](../../plugins/magpie-setup/skills/setup/setup_preflight/guides/pairing.md):
   the typical flow, what needs configuring, what to ask it, and how to make it yours.
   Dismiss it, or hide it for good, from its last line;
   *"show the pairing welcome again"* or `/magpie-setup:welcome-guide pairing` brings it back.
   ```



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@magpie.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org