Repository navigation
feat(setup): add setup family first-run welcome guide - #1725
Conversation
|
Hi @potiuk, I've completed the Setup family first-run welcome guide for #1662, following the established pattern from our previously merged welcome-guide contributions. It covers all 11 Setup skills, including installation, configuration, adoption, sandbox isolation, verification, upgrades, privacy controls, and upstream fixes. I've also added the standardized README integration, first-run evaluation fixture, and regression tests, while preserving the existing confirmation and safety boundaries. All repository-wide checks passed locally with |
- Renumber the first-run eval case to case-20, after the floor cases from apache#1673 and the repo-health case from apache#1724. - Present isolated-setup-update as the read-only drift check it is, and stop reusing the section heading's emoji for that step. - Name what a "make it yours" request becomes, as the other family guides do. - One sentence per line where the guide wrapped mid-sentence. Generated-by: Claude Opus 5
37530b7 to
b3f9fb7
Compare
potiuk
left a comment
There was a problem hiding this comment.
Thanks for the setup-family guide. It follows the established pattern closely: the 11 skills, the four optional config files and the /magpie-setup:… invocation forms all match the family as it ships, and test_welcome.py exercises the new guide on discovery, ordering, length and footer.
#1673 and #1724 merged after this was opened and edit the same eval counts, the case-9 report and the test_welcome.py lists, so rather than send it back I rebased the branch onto main and pushed two commits:
- your commit, rebased:
- the counts taken from
main(140 cases total, 20 forpreflight-floor, your setup description appended tomain's row); test_welcome.pykeeps both the repo-health and the setup entries in each list;case-9re-rendered withtools/dev/render-preflight-fixtures.py;- with one more family listed, the general guide went to 71 lines against the 70-line limit, so
guides/general.mdjoins two sentences that were split across lines to stay under it;
- the counts taken from
- a fixup (
b3f9fb79):- the eval case is renumbered to
case-20-setup-first-run, aftermain's floor cases and the repo-health case; - step 5 of the flow now presents
isolated-setup-updateas the read-only drift check it is ("check my sandbox for drift"), with its own emoji; - "make it yours" now names what a request becomes and how to upstream it;
- one sentence per line where the guide wrapped mid-sentence.
- the eval case is renumbered to
Thanks!
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.
Summary
docs/setup/README.mdusing the standardized family README layout, add welcome regression tests and a first-run evaluation fixture, regenerate affected welcome reports, and update evaluation case counts.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)
case-16-setup-first-runusing thestatusskill and its actual surface hash.render-preflight-fixtureshook.prek.git diff --checkpassed during implementation.RFC-AI-0004 compliance
privacy-llmworkflow but does not modify privacy enforcement or model-routing behavior.Linked issues
Closes #1662
Refs #1654
Notes for reviewers (optional)
setupstatuswelcome-guideisolated-setup-installisolated-setup-verifyisolated-setup-doctorisolated-setup-updateprivacy-llmshared-config-syncoverride-upstreamupstream-fixstatuswithsurface_hash: sha256:85dfb8b48739fc11.AI assistance disclosure: AI assistance was used for repository inspection, implementation drafting, and review. Changes were applied and validated locally by the contributor.