diff --git a/.typos.toml b/.typos.toml index d297490a5..e390cb435 100644 --- a/.typos.toml +++ b/.typos.toml @@ -40,6 +40,8 @@ extend-ignore-re = [ "`[0-9a-f]{7,40}`", "surface_hash: sha256:[0-9a-f]+", + # Fixture state stores the invoking skill's generated surface digest as JSON. + '"hash": "sha256:[0-9a-f]+"', "FRAMEWORK_FINGERPRINT = \"sha256:[0-9a-f]+\"", ] diff --git a/docs/pr-management/README.md b/docs/pr-management/README.md index c1adc9810..e74938095 100644 --- a/docs/pr-management/README.md +++ b/docs/pr-management/README.md @@ -84,6 +84,8 @@ wording, CI-check โ†’ doc-URL map, review-criteria source files). ## Install & first runs +New to this family? Read the [one-minute welcome guide](../../plugins/magpie-setup/skills/setup/setup_preflight/guides/pr-management.md). + Install just this family โ€” one plugin, 9 skills. Maintainer-facing PR-queue management. Once you have [added the marketplace](../setup/marketplace-install.md): diff --git a/plugins/magpie-setup/skills/setup/setup_preflight/guides/pr-management.md b/plugins/magpie-setup/skills/setup/setup_preflight/guides/pr-management.md new file mode 100644 index 000000000..5b0a85fd6 --- /dev/null +++ b/plugins/magpie-setup/skills/setup/setup_preflight/guides/pr-management.md @@ -0,0 +1,59 @@ + + +# ๐Ÿฆ Magpie here โ€” your PR-management sidekick + +A one-minute tour, then straight back to what you asked for. + +## โš™๏ธ Configure it + +Start with ``, the project's review criteria and its area labels. +`pr-management-code-review-criteria.md` names the criteria sources; +`pr-management-config.md` carries the labels and queue rules. +`reviewer-roster.md` tells reviewer routing who covers each area. + +- **Configure it for yourself** โ€” personal configuration, nothing committed โ€” `/magpie-setup:setup config` +- **Adopted** โ€” for your project: shared configuration committed to the repo โ€” `/magpie-setup:setup adopt` (a maintainers' decision) + +On a pinned-snapshot install, use `/magpie-setup config` or `/magpie-setup adopt`. + +Optional companion: roborev reviews your own branch before it becomes a PR; +this family helps you review and manage other people's PRs. +Neither requires the other. + +## ๐Ÿ”„ The typical flow + +1. **Triage the queue** โ€” propose a disposition for each PR โ€” *"triage the open PRs"* +2. **Route reviewers** โ€” use the roster to suggest the right people โ€” *"who should review this PR?"* +3. **Review** โ€” inspect the diff and draft inline feedback โ€” *"review this PR against our criteria"* +4. **Quick-merge** โ€” screen easy candidates and propose the command for you to run โ€” *"which PRs are ready for quick-merge?"* +5. **Mentor** โ€” help a contributor through the next step โ€” *"draft helpful feedback for this contributor"* +6. **Stale sweep** โ€” propose follow-ups for inactive PRs โ€” *"show me the stale PRs"* +7. **Stats** โ€” see where the queue needs attention โ€” *"summarise the PR backlog by area"* + +Nothing is written, posted, labelled or closed without your explicit confirmation. +Quick-merge never merges for you: it hands you the command. + +## ๐Ÿ’ฌ Just ask + +- *"check my branch before I open my first PR"* +- *"triage the PRs waiting for review"* +- *"who should review this PR?"* +- *"review this PR against our criteria"* +- *"review this PR stack in dependency order"* +- *"which PRs are ready for quick-merge?"* +- *"help this contributor understand the requested change"* +- *"what changed in the queue since the last sweep?"* +- *"summarise the PR backlog by area"* + +## ๐ŸŽจ Make it yours + +Change a workflow by describing the change: + +- *"from now on, group the backlog by our area labels"* +- *"use our review criteria when drafting feedback"* + +Each becomes an override for the PR-management skill it changes. +Useful to other maintainers? *"Upstream this change to Magpie"* prepares a generic PR for you to review before it opens. + + diff --git a/tools/setup-preflight/tests/test_welcome.py b/tools/setup-preflight/tests/test_welcome.py index 34628ca4d..051310a23 100644 --- a/tools/setup-preflight/tests/test_welcome.py +++ b/tools/setup-preflight/tests/test_welcome.py @@ -34,7 +34,7 @@ REPO_ROOT = Path(__file__).resolve().parents[3] SECURITY_SKILL = "issue-sync" -OTHER_SKILL = "pr-triage" +OTHER_SKILL = "ci-runner-audit" def stamp(root: Path) -> dict: @@ -136,6 +136,14 @@ def test_the_issue_family_guide_comes_on_the_next_run(project: Path, version) -> assert due(project, "magpie-issue-triage") == [("general", "again")] +def test_the_pr_management_family_guide_comes_on_the_next_run(project: Path, version) -> None: + assert due(project, "pr-triage") == [("general", "first-run")] + welcome.record(project, "general", "seen") + assert due(project, "pr-triage") == [("pr-management", "first-run")] + welcome.record(project, "pr-management", "seen") + assert due(project, "pr-triage") == [("general", "again")] + + def test_at_most_one_guide_per_run(project: Path, version) -> None: for _ in range(8): found = welcome_findings(project, SECURITY_SKILL) @@ -159,7 +167,7 @@ def test_a_hidden_general_guide_does_not_hold_back_the_family_one(project: Path, def test_a_skill_of_a_family_without_a_guide_gets_only_the_general_one(project: Path, version) -> None: - assert welcome.family_of(OTHER_SKILL) == "pr-management" + assert welcome.family_of(OTHER_SKILL) == "repo-health" assert due(project, OTHER_SKILL) == [("general", "first-run")] welcome.record(project, "general", "never") assert due(project, OTHER_SKILL) == [] @@ -431,13 +439,17 @@ def test_show_without_color_prints_the_markdown(capsys) -> None: # --- what ships ----------------------------------------------------------------------- -def test_the_rules_section_and_both_guides_ship() -> None: +def test_the_rules_section_and_all_guides_ship() -> None: assert welcome.SECTION in sections.available() - assert {"general", "security", "utilities", "mentoring", "pairing", "issue"} <= set(welcome.guides()) + assert {"general", "security", "utilities", "mentoring", "pairing", "issue", "pr-management"} <= set( + welcome.guides() + ) assert welcome.family_guides() == [g for g in welcome.guides() if g != "general"] -@pytest.mark.parametrize("name", ["general", "security", "utilities", "mentoring", "pairing", "issue"]) +@pytest.mark.parametrize( + "name", ["general", "security", "utilities", "mentoring", "pairing", "issue", "pr-management"] +) def test_each_guide_is_short_and_ends_with_the_way_back(name: str) -> None: text = welcome.guide(name) or "" assert not text.startswith(" + +There is no `.apache-magpie.lock`, no `.apache-magpie-overrides/` and no +`.apache-magpie-local/` at the repo root. The running agent is Claude Code +with magpie-setup 0.4.0 and magpie-pr-management 0.4.0 installed. + +The user has already seen the initial general welcome guide on an earlier run. +The invoked skill's own frontmatter reads `name: pr-triage` and +`surface_hash: sha256:54dc4ba1be7b36d4`; it belongs to the pr-management family. +This is the first time a pr-management skill has run here. +The user asked it to "triage the open PRs". + +The pre-flight command printed: + +```json +{ + "findings": [ + { + "code": "welcome", + "facts": { + "family": "pr-management", + "guide": "# \ud83d\udc26 Magpie here \u2014 your PR-management sidekick\n\nA one-minute tour, then straight back to what you asked for.\n\n## \u2699\ufe0f Configure it\n\nStart with ``, the project's review criteria and its area labels.\n`pr-management-code-review-criteria.md` names the criteria sources;\n`pr-management-config.md` carries the labels and queue rules.\n`reviewer-roster.md` tells reviewer routing who covers each area.\n\n- **Configure it for yourself** \u2014 personal configuration, nothing committed \u2014 `/magpie-setup:setup config`\n- **Adopted** \u2014 for your project: shared configuration committed to the repo \u2014 `/magpie-setup:setup adopt` (a maintainers' decision)\n\nOn a pinned-snapshot install, use `/magpie-setup config` or `/magpie-setup adopt`.\n\nOptional companion: roborev reviews your own branch before it becomes a PR;\nthis family helps you review and manage other people's PRs.\nNeither requires the other.\n\n## \ud83d\udd04 The typical flow\n\n1. **Triage the queue** \u2014 propose a disposition for each PR \u2014 *\"triage the open PRs\"*\n2. **Route reviewers** \u2014 use the roster to suggest the right people \u2014 *\"who should review this PR?\"*\n3. **Review** \u2014 inspect the diff and draft inline feedback \u2014 *\"review this PR against our criteria\"*\n4. **Quick-merge** \u2014 screen easy candidates and propose the command for you to run \u2014 *\"which PRs are ready for quick-merge?\"*\n5. **Mentor** \u2014 help a contributor through the next step \u2014 *\"draft helpful feedback for this contributor\"*\n6. **Stale sweep** \u2014 propose follow-ups for inactive PRs \u2014 *\"show me the stale PRs\"*\n7. **Stats** \u2014 see where the queue needs attention \u2014 *\"summarise the PR backlog by area\"*\n\nNothing is written, posted, labelled or closed without your explicit confirmation.\nQuick-merge never merges for you: it hands you the command.\n\n## \ud83d\udcac Just ask\n\n- *\"check my branch before I open my first PR\"*\n- *\"triage the PRs waiting for review\"*\n- *\"who should review this PR?\"*\n- *\"review this PR against our criteria\"*\n- *\"review this PR stack in dependency order\"*\n- *\"which PRs are ready for quick-merge?\"*\n- *\"help this contributor understand the requested change\"*\n- *\"what changed in the queue since the last sweep?\"*\n- *\"summarise the PR backlog by area\"*\n\n## \ud83c\udfa8 Make it yours\n\nChange a workflow by describing the change:\n\n- *\"from now on, group the backlog by our area labels\"*\n- *\"use our review criteria when drafting feedback\"*\n\nEach becomes an override for the PR-management skill it changes.\nUseful to other maintainers? *\"Upstream this change to Magpie\"* prepares a generic PR for you to review before it opens.\n\n## \ud83d\udc4b About this guide\n\n- **Continue** \u2014 show it again next time (three times at most)\n- **Dismiss** \u2014 hide it until the next Magpie upgrade\n- **Don't show again** \u2014 hide it for good; say *\"show the pr-management welcome again\"* to bring it back\n\nShow this again any time: `/magpie-setup:welcome-guide pr-management`\n(`/magpie-setup-welcome-guide pr-management` on a pinned snapshot).\n\n\ud83c\udf08 Prefer it in colour? Run this yourself \u2014 the `!` prefix runs it as a shell command:\n\n```text\n! PYTHONPATH=\".apache-magpie-local:$(git rev-parse --git-common-dir)/../.apache-magpie-local:$(git rev-parse --git-common-dir)/apache-magpie\" python3 -m setup_preflight.welcome show --family pr-management --color=always\n```\n", + "max_shown": 3, + "reason": "first-run", + "shown": 0 + }, + "scope": "family", + "section": "welcome" + } + ], + "rules": { + "welcome": "## welcome \u2014 a first-run welcome guide is due\n\nA welcome guide is due on this run: `facts.family` names it\n(`general`, for the first Magpie skill this user runs here, or the skill's own family),\nand `facts.reason` says why (`first-run`, `again`, or `upgraded` after a dismissal).\n`facts.guide` is the guide. The checker shows at most one guide per run and has already picked it.\n\n1. **Show `facts.guide` to the user verbatim**, as Markdown, before the work they asked for.\n Do not summarise, reword, trim, or add to it, and substitute nothing in it:\n its placeholders (``, ``, ``, \u2026) are meant to be read as written.\n2. **Offer the three choices in one line**:\n **Continue** (show again next time) \u00b7 **Dismiss** (hide until the next Magpie upgrade) \u00b7 **Don't show again**.\n3. **Record `seen` at once**, which is what no answer means, then carry on with the user's request in the same turn.\n Never block the requested work on the guide, and never wait for an answer before starting it.\n4. **When the user picks Dismiss or Don't show again** \u2014 now or later in the session \u2014 record that choice;\n it replaces `seen`. Continue needs nothing further.\n\n```bash\nPYTHONPATH=\".apache-magpie-local:$(git rev-parse --git-common-dir)/../.apache-magpie-local:$(git rev-parse --git-common-dir)/apache-magpie\" \\\n python3 -m setup_preflight.welcome record --family --choice \n```\n\n`seen` brings the guide back on a later run, `facts.max_shown` recorded showings in all (`facts.shown` so far);\n`dismiss` hides it until the framework version changes; `never` hides it until re-enabled.\nEvery write merges into the personal layer's `reconciled.json` under `welcome.`, keeping every other key;\nnever write it by hand.\nIf the command exits non-zero, say nothing more about it and carry on.\n\nAny guide can be shown again on request with `/magpie-setup:welcome-guide []`,\nwhich also turns a hidden one back on." + }, + "verdict": "action" +} +``` diff --git a/tools/skill-evals/evals/setup/preflight-floor/fixtures/case-14-pr-management-first-run/state.json b/tools/skill-evals/evals/setup/preflight-floor/fixtures/case-14-pr-management-first-run/state.json new file mode 100644 index 000000000..92deb91c0 --- /dev/null +++ b/tools/skill-evals/evals/setup/preflight-floor/fixtures/case-14-pr-management-first-run/state.json @@ -0,0 +1,24 @@ +{ + "lock": null, + "plugins": [ + [ + "magpie-setup", + "0.4.0" + ], + [ + "magpie-pr-management", + "0.4.0" + ] + ], + "reconciled": { + "welcome": { + "general": { + "choice": "seen", + "shown": 1 + } + } + }, + "skill": "pr-triage", + "welcome": true, + "hash": "sha256:54dc4ba1be7b36d4" +} diff --git a/tools/skill-evals/evals/setup/preflight-floor/fixtures/case-9-first-magpie-run/report.md b/tools/skill-evals/evals/setup/preflight-floor/fixtures/case-9-first-magpie-run/report.md index f70cb7a43..74e457478 100644 --- a/tools/skill-evals/evals/setup/preflight-floor/fixtures/case-9-first-magpie-run/report.md +++ b/tools/skill-evals/evals/setup/preflight-floor/fixtures/case-9-first-magpie-run/report.md @@ -20,7 +20,7 @@ The pre-flight command printed: "code": "welcome", "facts": { "family": "general", - "guide": "# \ud83d\udc26 Hello from Magpie \u2014 your project's maintainer sidekick\n\nOne minute, then straight back to what you asked for.\n\n## \ud83d\ude80 Getting started\n\n- \ud83d\udce6 **Install** from your agent's marketplace (Claude Code shown):\n `/plugin marketplace add apache/magpie`,\n then `/plugin install magpie-setup@apache-magpie` and one `/plugin install magpie-@apache-magpie` per family you want\n- \ud83d\ude4b **Configure it for yourself** \u2014 personal settings, nothing committed \u2014 `/magpie-setup:setup config`\n- \ud83d\udc65 **Adopt it for your project** \u2014 the configuration is committed to your repo and shared with every contributor \u2014\n `/magpie-setup:setup adopt` (a maintainers' decision)\n\nOn a pinned-snapshot install the commands are shorter: `/magpie-setup config`, `/magpie-setup adopt`.\n\n## \ud83d\udd04 Staying current\n\n- \u270b **By hand:** `claude plugin marketplace update apache-magpie`, then `claude plugin update @apache-magpie`\n- \ud83e\udd16 **Automatically (Claude Code):** `/plugin` \u2192 **Marketplaces** \u2192 **apache-magpie** \u2192 **Enable auto-update** \u2014\n it is off by default for third-party marketplaces like this one\n- \ud83e\udde9 Gemini CLI takes `--auto-update` at install time; Codex has no auto-update, so run `codex plugin marketplace upgrade`\n\nAfter an update, the next skill you run checks your configuration against it and proposes any fixes;\n`/magpie-setup:setup reconcile` checks everything at once\n(on a pinned snapshot, `/magpie-setup upgrade` does the update).\n\n## \ud83d\udcac Just ask\n\nTalk to Magpie in plain language \u2014 no syntax to learn.\nNothing is written, posted, or sent without your OK.\nInterrupt at any time, say no, or change your mind halfway through.\n\n## \ud83c\udfa8 You are the creator\n\nDescribe what you want a skill to do for you:\n\n- *\"from now on, always ask me before closing a stale issue\"*\n- *\"when you triage PRs, leave the bot-authored ones alone\"*\n\nMagpie records it as an override for that skill (`/magpie-setup:setup override `).\nWorth sharing? Say *\"upstream this change to Magpie\"* \u2014\nit makes the change generic and opens a PR to `apache/magpie` for you to review (`/magpie-setup:override-upstream`).\n\n## \ud83d\udcda More guides\n\nEach family can bring its own short guide, shown the first time you use it:\n\n- `issue` \u2014 `/magpie-setup:welcome-guide issue`\n- `mentoring` \u2014 `/magpie-setup:welcome-guide mentoring`\n- `pairing` \u2014 `/magpie-setup:welcome-guide pairing`\n- `security` \u2014 `/magpie-setup:welcome-guide security`\n- `utilities` \u2014 `/magpie-setup:welcome-guide utilities`\n\n## \ud83d\udc4b About this guide\n\n- **Continue** \u2014 show it again next time (three times at most)\n- **Dismiss** \u2014 hide it until the next Magpie upgrade\n- **Don't show again** \u2014 hide it for good; say *\"show the Magpie welcome again\"* to bring it back\n\nShow this again any time: `/magpie-setup:welcome-guide []`\n(`/magpie-setup-welcome-guide []` on a pinned snapshot).\n\n\ud83c\udf08 Prefer it in colour? Run this yourself \u2014 the `!` prefix runs it as a shell command:\n\n```text\n! PYTHONPATH=\".apache-magpie-local:$(git rev-parse --git-common-dir)/../.apache-magpie-local:$(git rev-parse --git-common-dir)/apache-magpie\" python3 -m setup_preflight.welcome show --family general --color=always\n```\n", + "guide": "# \ud83d\udc26 Hello from Magpie \u2014 your project's maintainer sidekick\n\nOne minute, then straight back to what you asked for.\n\n## \ud83d\ude80 Getting started\n\n- \ud83d\udce6 **Install** from your agent's marketplace (Claude Code shown):\n `/plugin marketplace add apache/magpie`,\n then `/plugin install magpie-setup@apache-magpie` and one `/plugin install magpie-@apache-magpie` per family you want\n- \ud83d\ude4b **Configure it for yourself** \u2014 personal settings, nothing committed \u2014 `/magpie-setup:setup config`\n- \ud83d\udc65 **Adopt it for your project** \u2014 the configuration is committed to your repo and shared with every contributor \u2014\n `/magpie-setup:setup adopt` (a maintainers' decision)\n\nOn a pinned-snapshot install the commands are shorter: `/magpie-setup config`, `/magpie-setup adopt`.\n\n## \ud83d\udd04 Staying current\n\n- \u270b **By hand:** `claude plugin marketplace update apache-magpie`, then `claude plugin update @apache-magpie`\n- \ud83e\udd16 **Automatically (Claude Code):** `/plugin` \u2192 **Marketplaces** \u2192 **apache-magpie** \u2192 **Enable auto-update** \u2014\n it is off by default for third-party marketplaces like this one\n- \ud83e\udde9 Gemini CLI takes `--auto-update` at install time; Codex has no auto-update, so run `codex plugin marketplace upgrade`\n\nAfter an update, the next skill you run checks your configuration against it and proposes any fixes;\n`/magpie-setup:setup reconcile` checks everything at once\n(on a pinned snapshot, `/magpie-setup upgrade` does the update).\n\n## \ud83d\udcac Just ask\n\nTalk to Magpie in plain language \u2014 no syntax to learn.\nNothing is written, posted, or sent without your OK.\nInterrupt at any time, say no, or change your mind halfway through.\n\n## \ud83c\udfa8 You are the creator\n\nDescribe what you want a skill to do for you:\n\n- *\"from now on, always ask me before closing a stale issue\"*\n- *\"when you triage PRs, leave the bot-authored ones alone\"*\n\nMagpie records it as an override for that skill (`/magpie-setup:setup override `).\nWorth sharing? Say *\"upstream this change to Magpie\"* \u2014\nit makes the change generic and opens a PR to `apache/magpie` for you to review (`/magpie-setup:override-upstream`).\n\n## \ud83d\udcda More guides\n\nEach family can bring its own short guide, shown the first time you use it:\n\n- `issue` \u2014 `/magpie-setup:welcome-guide issue`\n- `mentoring` \u2014 `/magpie-setup:welcome-guide mentoring`\n- `pairing` \u2014 `/magpie-setup:welcome-guide pairing`\n- `pr-management` \u2014 `/magpie-setup:welcome-guide pr-management`\n- `security` \u2014 `/magpie-setup:welcome-guide security`\n- `utilities` \u2014 `/magpie-setup:welcome-guide utilities`\n\n## \ud83d\udc4b About this guide\n\n- **Continue** \u2014 show it again next time (three times at most)\n- **Dismiss** \u2014 hide it until the next Magpie upgrade\n- **Don't show again** \u2014 hide it for good; say *\"show the Magpie welcome again\"* to bring it back\n\nShow this again any time: `/magpie-setup:welcome-guide []`\n(`/magpie-setup-welcome-guide []` on a pinned snapshot).\n\n\ud83c\udf08 Prefer it in colour? Run this yourself \u2014 the `!` prefix runs it as a shell command:\n\n```text\n! PYTHONPATH=\".apache-magpie-local:$(git rev-parse --git-common-dir)/../.apache-magpie-local:$(git rev-parse --git-common-dir)/apache-magpie\" python3 -m setup_preflight.welcome show --family general --color=always\n```\n", "max_shown": 3, "reason": "first-run", "shown": 0