Repository navigation
feat(setup): first-run welcome guides, general and for the security skills - #1653
Merged
Merged
Conversation
This was referenced Oct 16, 2026
potiuk
force-pushed
the
feat/security-welcome-guide
branch
from
October 16, 2026 05:37
3fe1967 to
c74f634
Compare
…kills The first time any Magpie skill runs, the pre-flight checker now returns a `welcome` finding carrying a short general guide: how to install, configure for yourself or adopt for the project, how to upgrade and turn on automatic plugin updates, that you can just ask in plain language and nothing happens without your OK, and that users are creators: describe what a skill should do for you and it becomes an override, and "upstream this change to Magpie" makes it generic and opens a PR. The security family has its own guide: the typical flow (import, triage, sync, CVE, fix, announce) with an example request per step. At most one guide is shown per run, the general one first; a family guide follows on a later run of that family's skills. The agent shows the guide, then carries on with the task. Continue shows it again (three times at most), Dismiss hides it until the next upgrade, Don't show again hides it until it is turned back on. The choice lives in the personal layer's reconciled.json. Every guide ends by naming the new `/magpie-setup:welcome-guide [<family>]` skill, which shows any guide on demand and turns a hidden one back on; `--color` prints a coloured terminal version. The skill-to-family map the checker needs is generated from frontmatter and kept in sync by check-family-plugins. Generated-by: Claude Opus 5
potiuk
force-pushed
the
feat/security-welcome-guide
branch
from
October 16, 2026 06:11
c74f634 to
affd7bd
Compare
Skip optional welcome guides during checker verification and preserve setup findings when a guide cannot be read. Restrict lookup to shipped guides and refresh agent links and generated skill metadata. Generated-by: Codex (GPT-6)
potiuk
force-pushed
the
feat/security-welcome-guide
branch
from
October 16, 2026 06:18
affd7bd to
48ec3d9
Compare
9 of 21 tasks
Kaap10
added a commit
to Kaap10/magpie
that referenced
this pull request
Oct 16, 2026
…#1663) Adds a concise first-run welcome guide for the utilities skill family (list-skills, write-skill, optimize-skill, report-framework-issue, and skill-reconciler), following the pattern established in apache#1653. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/utilities.md - Highlights the typical utilities flow and notes zero configuration needed - Links the guide from docs/utilities/README.md under Install & first runs - Supports personal layer reconciled state in render-preflight-fixtures.py - Adds case-10-utilities-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and adds cross-platform symlink robustness
Kaap10
added a commit
to Kaap10/magpie
that referenced
this pull request
Oct 16, 2026
…#1663) Adds a concise first-run welcome guide for the utilities skill family (list-skills, write-skill, optimize-skill, report-framework-issue, and skill-reconciler), following the pattern established in apache#1653. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/utilities.md - Highlights the typical utilities flow and notes zero configuration needed - Links the guide from docs/utilities/README.md under Install & first runs - Supports personal layer reconciled state in render-preflight-fixtures.py - Adds case-10-utilities-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and adds cross-platform symlink robustness
potiuk
pushed a commit
to Kaap10/magpie
that referenced
this pull request
Oct 16, 2026
…#1663) Adds a concise first-run welcome guide for the utilities skill family (list-skills, write-skill, optimize-skill, report-framework-issue, and skill-reconciler), following the pattern established in apache#1653. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/utilities.md - Highlights the typical utilities flow and notes zero configuration needed - Links the guide from docs/utilities/README.md under Install & first runs - Supports personal layer reconciled state in render-preflight-fixtures.py - Adds case-10-utilities-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and adds cross-platform symlink robustness
potiuk
pushed a commit
to Kaap10/magpie
that referenced
this pull request
Oct 16, 2026
…#1663) Adds a concise first-run welcome guide for the utilities skill family (list-skills, write-skill, optimize-skill, report-framework-issue, and skill-reconciler), following the pattern established in apache#1653. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/utilities.md - Highlights the typical utilities flow and notes zero configuration needed - Links the guide from docs/utilities/README.md under Install & first runs - Supports personal layer reconciled state in render-preflight-fixtures.py - Adds case-10-utilities-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and adds cross-platform symlink robustness
potiuk
added a commit
that referenced
this pull request
Oct 16, 2026
…#1669) * feat(setup): first-run welcome guide for the utilities family (#1663) Adds a concise first-run welcome guide for the utilities skill family (list-skills, write-skill, optimize-skill, report-framework-issue, and skill-reconciler), following the pattern established in #1653. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/utilities.md - Highlights the typical utilities flow and notes zero configuration needed - Links the guide from docs/utilities/README.md under Install & first runs - Supports personal layer reconciled state in render-preflight-fixtures.py - Adds case-10-utilities-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and adds cross-platform symlink robustness * Describe list-skills and skill-reconciler accurately in the utilities guide list-skills indexes installed skills only, and skill-reconciler compares two near-duplicate skills rather than a repo against its snapshot. Also replaces the empty `except OSError: pass` flagged by CodeQL with `contextlib.suppress`, and re-renders the case-10 fixture. Generated-by: Claude Opus 5 * Test the text-file mirror fallback and drop the unrelated stdout change scan_families() now has a test for a mirror entry checked out as a plain file holding its target path, as git writes it without symlink support, including an entry whose target does not exist. The stdout.reconfigure() in main() is unrelated to the utilities guide and is removed from this change. Generated-by: Claude Opus 5 --------- Co-authored-by: Jarek Potiuk <potiuk@apache.org>
9 of 21 tasks
Kaap10
added a commit
to Kaap10/magpie
that referenced
this pull request
Oct 19, 2026
apache#1658) Adds a concise first-run welcome guide for the contributor-growth skill family (activity-sweep, calibrate, candidate-screen, committer-onboarding, contributor-to-committer, identity-map, nomination, onboarding-concierge, and sentiment), following the pattern established in apache#1653 and apache#1663. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/contributor-growth.md - Highlights typical flow across 7 steps and notes private list / calibrated thresholds - Links the guide from docs/contributor-growth/README.md under Install & first runs - Adds case-11-contributor-growth-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and updates total eval case counts
Kaap10
added a commit
to Kaap10/magpie
that referenced
this pull request
Oct 19, 2026
apache#1658) Adds a concise first-run welcome guide for the contributor-growth skill family (activity-sweep, calibrate, candidate-screen, committer-onboarding, contributor-to-committer, identity-map, nomination, onboarding-concierge, and sentiment), following the pattern established in apache#1653 and apache#1663. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/contributor-growth.md - Highlights typical flow across 7 steps and notes private list / calibrated thresholds - Links the guide from docs/contributor-growth/README.md under Install & first runs - Adds case-11-contributor-growth-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and updates total eval case counts
9 of 22 tasks
This was referenced Oct 19, 2026
potiuk
added a commit
that referenced
this pull request
Oct 19, 2026
#1658) (#1702) * feat(setup): first-run welcome guide for the contributor-growth family (#1658) Adds a concise first-run welcome guide for the contributor-growth skill family (activity-sweep, calibrate, candidate-screen, committer-onboarding, contributor-to-committer, identity-map, nomination, onboarding-concierge, and sentiment), following the pattern established in #1653 and #1663. - Adds plugins/magpie-setup/skills/setup/setup_preflight/guides/contributor-growth.md - Highlights typical flow across 7 steps and notes private list / calibrated thresholds - Links the guide from docs/contributor-growth/README.md under Install & first runs - Adds case-11-contributor-growth-first-run preflight-floor fixture and updates case-9 - Expands test_welcome.py test coverage and updates total eval case counts * docs(setup): name the contributor-growth config files; test the next run The guide's "Configure it" section described private-list access and thresholds without naming a file to configure. It now names the file each skill reads (`committer-readiness.md`, `contributor-nomination-config.md`, the onboarding and sentiment configs, and `privacy-llm.md` for the private-list reads), and says `setup config` configures rather than "personal install". Every other family guide has a test that the family's skills resolve to it and that it follows the general guide on the next run; this family now has one too. The case-11 fixture that embeds the guide is re-rendered. Generated-by: Claude Opus 5 --------- Co-authored-by: Jarek Potiuk <potiuk@apache.org>
This was referenced Oct 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
welcomefinding, so no SKILL.md pre-flight block changes. Continue shows a guide again (three times at most), Dismiss hides it until the next upgrade, Don't show again hides it until turned back on. The choice lives in the personal layer'sreconciled.json./magpie-setup:welcome-guide [<family>]skill shows any guide on demand and turns a hidden one back on (namedwelcome-guidebecausewelcomeis the mentoring family's skill); every guide ends by naming it.--colorprints a coloured terminal version.Type of change
.claude/skills/<name>/) — eval fixtures updated belowtools/*/withpyproject.toml)docs/,README.md,CONTRIBUTING.md)prek, workflows, validators)Test plan
tools/setup-preflight: pytest (33 new welcome tests: first run, non-security skill, each choice, three-showings limit, dismiss lifted by an upgrade, enable, record merging intoreconciled.json,--colorwithNO_COLORand non-tty),mypytools/dev: the skill-to-family map is generated from frontmatter;check-family-pluginsreports a stale map and--fixregenerates itsetup/preflight-floorcase 9 (first Magpie run shows the general guide); new suitesetup-welcome-guide/step-1-show(no argument, a known family, an unknown name);render-preflight-fixtures --checkcleancheck-doc-sync(80 skills),check-shared-blocks,check-duplication(shared footer inguides/_footer.md)skill-surface-hashandskill-token-countrestamped for the setup skill only; typos cleanprek run --all-files— left to CI (prepared outside a checkout)RFC-AI-0004 compliance
Linked issues
Notes for reviewers (optional)
magpie-setupplugin version; on a marketplace install, whose personal-layer checker copy has no manifest, it falls back to a fingerprint of the package, whichupgraderefreshes.Generative AI disclosure: prepared with Claude Code (Claude Opus 5); reviewed by the author.
🤖 Generated with Claude Code