Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/issue-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,12 @@ New to Magpie? The [quick start](../quick-start.md) walks the whole path in
one place — install, the first `/magpie-setup:setup` run, and a recording of it
happening — plus the other agents and the secure-isolation setup to run next.

The first issue skill you run opens with a one-minute
[welcome guide](../../plugins/magpie-setup/skills/setup/setup_preflight/guides/issue.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 issue welcome again"* or `/magpie-setup:welcome-guide issue` brings it back.

### Before the first run

<!-- BEGIN generated: skill-config (tools/dev/check-skill-config.py --fix) -->
Expand Down
57 changes: 57 additions & 0 deletions plugins/magpie-setup/skills/setup/setup_preflight/guides/issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->

# 🐦 Magpie here — your issue-management sidekick

A one-minute tour, then straight back to what you asked for.

## 🔄 The typical flow

1. 🏷️ **Triage** incoming issues and draft tracker replies — *"triage the open issues"*
2. 🔁 **Deduplicate** related reports and propose which to keep — *"find duplicate issues"*
3. 🧪 **Reproduce** a reported bug from its code — *"reproduce issue ABC-123"*
4. 🔍 **Reassess** resolved or end-of-life issues against today's code — *"re-assess old issues"*
5. 🛠️ **Draft a fix** with tests and a hand-back — *"draft a fix for ABC-123"*
6. 🧹 **Sweep stale issues** and review proposed actions — *"find stale issues"*
7. 📊 **Report** backlog and reassessment statistics — *"show backlog statistics"*

`reassess-stats` reports on reassessment results; `backlog-stats` reports on the backlog.
Tracker comments and issue closures require confirmation.
Stale closures need a second confirmation.
The fix workflow opens a draft PR only with `--draft-pr` and explicit approval.

## ⚙️ Configure it

Different skills need different project settings:

- 🗂️ **Tracker** — `issue-tracker-config.md` for triage, deduplication, reproduction, stale sweep, reassessment and statistics
- 📖 **Project** — `project.md` additionally for triage and stale sweep
- 🧪 **Investigation** — `reproducer-conventions.md` and `runtime-invocation.md` for reproduction; `reassess-pool-defaults.md` for reassessment
- 🛠️ **Fixes** — `fix-workflow.md` and `runtime-invocation.md` for drafting fixes

Configure personally with `/magpie-setup:setup config`.
Shared adoption with `/magpie-setup:setup adopt` is a maintainer decision.

## 💬 Just ask

Talk to Magpie in plain language:

- *"triage these incoming bugs and show me draft replies"*
- *"find duplicates without closing anything"*
- *"reproduce this issue and explain what you found"*
- *"reassess the issue backlog and summarize the results"*
- *"draft a fix for this confirmed bug"*
- *"review stale issues before posting or closing"*
- *"show backlog and reassessment statistics"*

## 🎨 Make it yours

Describe how you want the issue workflow to behave:

- *"use our tracker conventions when drafting triage replies"*
- *"adjust the stale-issue thresholds for this project"*

Review configuration or override proposals before applying them.
Useful elsewhere? Ask *"upstream this change to Magpie"* to prepare a contribution for review.

<!-- welcome footer: generated from guides/_footer.md -->
32 changes: 29 additions & 3 deletions tools/setup-preflight/tests/test_welcome.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,29 @@ def test_the_pairing_family_guide_comes_on_the_next_run(project: Path, version)
assert due(project, "self-review") == [("general", "again")]


def test_the_issue_family_guide_comes_on_the_next_run(project: Path, version) -> None:
for skill in (
"backlog-stats",
"deduplicate",
"fix-workflow",
"reassess",
"reassess-stats",
"reproducer",
"stale-sweep",
):
assert welcome.family_of(skill) == "issue"

# The bare issue-triage name belongs to Security, not Issue.
assert welcome.family_of("issue-triage") == "security"
assert welcome.family_of("magpie-issue-triage") == "issue"

assert due(project, "magpie-issue-triage") == [("general", "first-run")]
welcome.record(project, "general", "seen")
assert due(project, "magpie-issue-triage") == [("issue", "first-run")]
welcome.record(project, "issue", "seen")
assert due(project, "magpie-issue-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)
Expand Down Expand Up @@ -410,11 +433,11 @@ def test_show_without_color_prints_the_markdown(capsys) -> None:

def test_the_rules_section_and_both_guides_ship() -> None:
assert welcome.SECTION in sections.available()
assert {"general", "security", "utilities", "mentoring", "pairing"} <= set(welcome.guides())
assert {"general", "security", "utilities", "mentoring", "pairing", "issue"} <= 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"])
@pytest.mark.parametrize("name", ["general", "security", "utilities", "mentoring", "pairing", "issue"])
def test_each_guide_is_short_and_ends_with_the_way_back(name: str) -> None:
text = welcome.guide(name) or ""
assert not text.startswith("<!--")
Expand All @@ -438,7 +461,8 @@ def test_the_footer_is_shared_and_filled_in_per_guide() -> None:
utilities = welcome.guide("utilities") or ""
mentoring = welcome.guide("mentoring") or ""
pairing = welcome.guide("pairing") or ""
for text in (security, general, utilities, mentoring, pairing):
issue = welcome.guide("issue") or ""
for text in (security, general, utilities, mentoring, pairing, issue):
assert "{{" not in text
assert "welcome footer: generated" not in text
assert "`/magpie-setup:welcome-guide security`" in security
Expand All @@ -451,6 +475,8 @@ def test_the_footer_is_shared_and_filled_in_per_guide() -> None:
assert "--family mentoring --color=always" in mentoring
assert "`/magpie-setup:welcome-guide pairing`" in pairing
assert "--family pairing --color=always" in pairing
assert "`/magpie-setup:welcome-guide issue`" in issue
assert "--family issue --color=always" in issue


def test_list_prints_every_guide(capsys) -> None:
Expand Down
2 changes: 1 addition & 1 deletion tools/skill-evals/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Behavioral eval harness for Apache Magpie skills. Each eval suite tests a skill

Suites are currently implemented for:

- **setup** — 132 cases across 30 steps (step-verify-drift, step-overrides-surface, step-override-bypass, step-m3-baseline-pick, step-m4-install-gates, step-m5-no-repo-offer, step-m5-companion-offer, step-upgrade-companion-offer, step-adopt-settings-merge, verify-default-set, uninstall-default-set, lock-marketplace-parse, adopt-write-floor, setup-prefill-from-floor, preflight-floor, upgrade-adoption-split, verify-floor, adopt-review-process, adopt-security-list, step-reconcile, step-verify, step-config-stamp, step-config-adversarial, step-config-mail, step-adopt-stamp, step-upgrade-stamp, step-delegate-propose, config-vcs-backend, config-local-custom-parser)
- **setup** — 133 cases across 30 steps (step-verify-drift, step-overrides-surface, step-override-bypass, step-m3-baseline-pick, step-m4-install-gates, step-m5-no-repo-offer, step-m5-companion-offer, step-upgrade-companion-offer, step-adopt-settings-merge, verify-default-set, uninstall-default-set, lock-marketplace-parse, adopt-write-floor, setup-prefill-from-floor, preflight-floor, upgrade-adoption-split, verify-floor, adopt-review-process, adopt-security-list, step-reconcile, step-verify, step-config-stamp, step-config-adversarial, step-config-mail, step-adopt-stamp, step-upgrade-stamp, step-delegate-propose, config-vcs-backend, config-local-custom-parser)
- **setup-isolated-setup-install** — 19 cases across 5 steps (runtime-routing, step-snapshot-drift, step-scope-confirm, step-hardware-key, step-roborev-exclusion)
- **setup-privacy-llm** — 6 cases across 2 steps (step-1-resolve, step-4-gate)
- **setup-shared-config-sync** — 12 cases across 2 steps (step-3-decide-action, step-5-draft-commit)
Expand Down
4 changes: 2 additions & 2 deletions tools/skill-evals/evals/setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Behavioral evals for the `setup` skill.

## Suites (132 cases total)
## Suites (133 cases total)

| Suite | Step | Cases | What it covers |
|---|---|---|---|
Expand All @@ -25,7 +25,7 @@ Behavioral evals for the `setup` skill.
| adopt-review-process | adopt.md § Step 4c | 5 | a fresh adopt finding two deviations in the confirmed documents where one is accepted and one rejected, and a release policy left alone because that family is not in the floor; a re-adoption reviewing only the one family the floor diff added; a re-adoption that adds no family, where edited process documents are still not re-read; a sentence that would weaken a merge confirmation gate, dropped and named while a label deviation beside it is written; and a repo whose only candidate document the maintainer un-ticks, skipping the step |
| adopt-security-list | adopt.md § Step 4b | 4 | an ASF project whose dedicated security list is in its docs and on the ASF page (recommend `security@`); an ASF project with no dedicated list (no recommendation, `private@` only as a flagged fallback); a non-ASF project, which is not asked; and conflicting evidence between `SECURITY.md` and the ASF page (no recommendation, flagged fallback) |
| setup-prefill-from-floor | install.md § Step M0b | 4 | adopted (propose the floor), unadopted (framework defaults), a foreign marketplace called out, and a snapshot lock falling through |
| preflight-floor | preflight-block.md § Pre-flight | 12 | at floor (silent), below floor (update), plugin missing (install), foreign marketplace (ask first, run nothing), no `claude` CLI (print), unadopted (propose setup), `apache/magpie` in an alarming context (update anyway, unasked), unreadable `claude plugin list --json` (silent, treated as unknown not absent), first Magpie run (show the general welcome guide, record it, carry on), first utilities run (show the utilities welcome guide, record it, carry on), first mentoring run (show the mentoring welcome guide, record it, carry on), first pairing run (show the pairing welcome guide, record it, carry on) |
| preflight-floor | preflight-block.md § Pre-flight | 13 | at floor (silent), below floor (update), plugin missing (install), foreign marketplace (ask first, run nothing), no `claude` CLI (print), unadopted (propose setup), `apache/magpie` in an alarming context (update anyway, unasked), unreadable `claude plugin list --json` (silent, treated as unknown not absent), first Magpie run (show the general welcome guide, record it, carry on), first utilities run (show the utilities welcome guide, record it, carry on), first mentoring run (show the mentoring welcome guide, record it, carry on), first pairing run (show the pairing welcome guide, record it, carry on), first issue run (show the issue welcome guide, record it, carry on) |
| upgrade-adoption-split | upgrade.md § Step 0b | 4 | not adopted (nothing staged), adopted (floor raised and staged), already ahead (floor unchanged), snapshot method (falls through) |
| verify-floor | verify.md § Adoption floor | 4 | no lock (not a fault), ahead of floor with extra plugins (not a fault), a shortfall (a fault), a floor plugin the marketplace no longer ships (a fault, not installed around) |
| step-reconcile | reconcile.md § The sweep | 3 | a clean sweep on a pinned-snapshot install (anchor present, config resolved — stamp written, nothing proposed), a renamed step heading stranding an override's anchor (one re-anchor proposal named), a marketplace install whose plugin cache is sandbox-denied (anchor resolution left `unchecked`, config resolution still completes) |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"tags":["local-smoke"]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"action": "welcome", "commands": [], "blocks": false}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->

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-issue 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: triage` and
`surface_hash: sha256:fb90bdc45aec5f8a`; it belongs to the issue family.
This is the first time an issue-family skill has run here.
The user asked it to "triage these incoming issues".

The pre-flight command printed:

```json
{
"findings": [
{
"code": "welcome",
"facts": {
"family": "issue",
"guide": "# \ud83d\udc26 Magpie here \u2014 your issue-management sidekick\n\nA one-minute tour, then straight back to what you asked for.\n\n## \ud83d\udd04 The typical flow\n\n1. \ud83c\udff7\ufe0f **Triage** incoming issues and draft tracker replies \u2014 *\"triage the open issues\"*\n2. \ud83d\udd01 **Deduplicate** related reports and propose which to keep \u2014 *\"find duplicate issues\"*\n3. \ud83e\uddea **Reproduce** a reported bug from its code \u2014 *\"reproduce issue ABC-123\"*\n4. \ud83d\udd0d **Reassess** resolved or end-of-life issues against today's code \u2014 *\"re-assess old issues\"*\n5. \ud83d\udee0\ufe0f **Draft a fix** with tests and a hand-back \u2014 *\"draft a fix for ABC-123\"*\n6. \ud83e\uddf9 **Sweep stale issues** and review proposed actions \u2014 *\"find stale issues\"*\n7. \ud83d\udcca **Report** backlog and reassessment statistics \u2014 *\"show backlog statistics\"*\n\n`reassess-stats` reports on reassessment results; `backlog-stats` reports on the backlog.\nTracker comments and issue closures require confirmation.\nStale closures need a second confirmation.\nThe fix workflow opens a draft PR only with `--draft-pr` and explicit approval.\n\n## \u2699\ufe0f Configure it\n\nDifferent skills need different project settings:\n\n- \ud83d\uddc2\ufe0f **Tracker** \u2014 `issue-tracker-config.md` for triage, deduplication, reproduction, stale sweep, reassessment and statistics\n- \ud83d\udcd6 **Project** \u2014 `project.md` additionally for triage and stale sweep\n- \ud83e\uddea **Investigation** \u2014 `reproducer-conventions.md` and `runtime-invocation.md` for reproduction; `reassess-pool-defaults.md` for reassessment\n- \ud83d\udee0\ufe0f **Fixes** \u2014 `fix-workflow.md` and `runtime-invocation.md` for drafting fixes\n\nConfigure personally with `/magpie-setup:setup config`.\nShared adoption with `/magpie-setup:setup adopt` is a maintainer decision.\n\n## \ud83d\udcac Just ask\n\nTalk to Magpie in plain language:\n\n- *\"triage these incoming bugs and show me draft replies\"*\n- *\"find duplicates without closing anything\"*\n- *\"reproduce this issue and explain what you found\"*\n- *\"reassess the issue backlog and summarize the results\"*\n- *\"draft a fix for this confirmed bug\"*\n- *\"review stale issues before posting or closing\"*\n- *\"show backlog and reassessment statistics\"*\n\n## \ud83c\udfa8 Make it yours\n\nDescribe how you want the issue workflow to behave:\n\n- *\"use our tracker conventions when drafting triage replies\"*\n- *\"adjust the stale-issue thresholds for this project\"*\n\nReview configuration or override proposals before applying them.\nUseful elsewhere? Ask *\"upstream this change to Magpie\"* to prepare a contribution for review.\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 issue welcome again\"* to bring it back\n\nShow this again any time: `/magpie-setup:welcome-guide issue`\n(`/magpie-setup-welcome-guide issue` 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 issue --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 (`<security-list>`, `<tracker>`, `<family>`, \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 <facts.family> --choice <seen|dismiss|never>\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.<facts.family>`, 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 [<family>]`,\nwhich also turns a hidden one back on."
},
"verdict": "action"
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"lock": null,
"plugins": [
[
"magpie-setup",
"0.4.0"
],
[
"magpie-issue",
"0.4.0"
]
],
"reconciled": {
"welcome": {
"general": {
"choice": "seen",
"shown": 1
}
}
},
"skill": "triage",
"welcome": true,
"hash": "sha256:fb90bdc45aec5f8a"
}
Loading