Repository navigation
docs(setup): add PR-management welcome guide - #1701
Conversation
Add the first-run family guide, link it from the documentation and cover the welcome sequence with a regression test and rendered fixture. Refs: apache#1655 Generated-by: Codex (GPT-6)
Kaap10
left a comment
There was a problem hiding this comment.
Thanks @leninworld for putting this together! The structure and test coverage follow the pattern established in #1653 and #1669 well.
Before merge, there are a few fixture state corrections and consistency adjustments needed:
surface_hashin eval fixture:report.mdquotessha256:2edc90a1b7f3440d(the hash forlist-skills), whereaspr-triageissha256:54dc4ba1be7b36d4.- Fixture sequence numbering: There is no
case-11onmain, so naming thiscase-12creates an unexpected gap. - Full skill prompt coverage: Include prompt examples for all 9 skills under
## Just ask(quick-merge,reviewer-routing,stats). - Visual parity: Add standard emoji accents (
🐦,🔄,⚙️,💬,🎨) to match the other family guides.
…nagement.md Co-authored-by: Vardhman Gupta <112063624+Kaap10@users.noreply.github.com>
…nagement.md Co-authored-by: Vardhman Gupta <112063624+Kaap10@users.noreply.github.com>
…-pr-management-first-run/state.json Co-authored-by: Vardhman Gupta <112063624+Kaap10@users.noreply.github.com>
Use the pr-triage surface hash in the fixture state and report prose, provide all nine skill prompts, match the family guide headings, and rename the shipping test to describe all guides. Renumber the fixture as requested and narrowly exclude generated JSON hashes from spelling. Preserve the three accepted suggestion commits and repair the invalid JSON introduced by the applied state.json suggestion. Refs: apache#1655 Generated-by: Codex (GPT-6)
Done. Thank you! |
Kaap10
left a comment
There was a problem hiding this comment.
LGTM! Thanks @leninworld for addressing all review points so quickly.
Next maintainer will look into it and take it forward!
…ER_SKILL `/magpie-setup:setup config` configures the skills already installed and installs nothing, so the guide's bullet now reads "Configure it for yourself" rather than "Installed". The welcome tests need a skill whose family ships no guide. Moving it to `activity-sweep` would break as soon as the contributor-growth guide lands, so it is `ci-runner-audit` (repo-health), a family with no guide in flight. The fixture that embeds the guide is re-rendered. Generated-by: Claude Opus 5
…701-fixup Generated-by: Claude Opus 5 # Conflicts: # tools/setup-preflight/tests/test_welcome.py # tools/skill-evals/README.md # tools/skill-evals/evals/setup/README.md # tools/skill-evals/evals/setup/preflight-floor/fixtures/case-9-first-magpie-run/report.md
…701-fixup Generated-by: Claude Opus 5 # Conflicts: # tools/setup-preflight/tests/test_welcome.py # tools/skill-evals/evals/setup/README.md # tools/skill-evals/evals/setup/preflight-floor/fixtures/case-9-first-magpie-run/report.md
potiuk
left a comment
There was a problem hiding this comment.
Adds the PR-management welcome guide covering all nine skills; the config files it names, the quick-merge "hands you the command" claim and the pr-triage surface hash all check out, every point from the earlier review is addressed, and the .typos.toml pattern is needed (typos flags ba inside the fixture's hash).
I pushed two commits rather than send this round again:
- 50e8af5 — fixup. The bullet for
/magpie-setup:setup configwas labelled Installed, butconfigconfigures the skills you already installed and installs nothing, so it now reads Configure it for yourself. The welcome tests need a skill whose family ships no guide;activity-sweepwould have broken as soon as the contributor-growth guide (#1702) lands, soOTHER_SKILLis nowci-runner-audit(repo-health), a family with no guide in flight. - d39a03c, 961333a — merges of
main. The mentoring (#1708), pairing (#1706) and issue (#1709) guides landed first and claimed the same slots, so this fixture is nowcase-14-pr-management-first-run, the setup case counts go to 134, the test lists carry every family, and thecase-9report is re-rendered.
I also approved the held workflow runs; the PR merges automatically once they are green. Thanks for your first contribution!
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.
This PR addresses part of issue #1655.
Summary
test_welcome.py.case-11-pr-management-first-runand update the generated case-9 report and case counts. The guide uses the shared welcome section, like the utilities guide (PR #1669); no core logic changes.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
Linux ARM64 Docker, Python 3.12, uv 0.11.8, Git 2.47.3.
prek run --all-filespasses (every hook, including workspace pytest and lychee)uv run pytest/ruff check/mypypasses (setup-preflight: 257 passed; mypy: no issues in 26 source files)(
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)
render-preflight-fixtures.py --checkpasses; the new sequence test fails without the guide and passes with it;python -m setup_preflight.welcome show --family pr-managementrenders the guide and shared footer (69 lines).Not run: provider-driven skill evals (they need model calls) and hosted CI (not yet run). The container used a child-subreaper wrapper for normal orphan reaping; project code and test assertions are unchanged. A wheel-build probe fails identically on unchanged
mainand on this branch, because the package config addssetup_preflight/guides/_footer.mdtwice. No packaging change or successful wheel build is claimed.RFC-AI-0004 compliance
<PROJECT>,<tracker>,<upstream>,<security-list>) used in all skill / tool prose (thecheck-placeholdersprek hook is the mechanical gate)No new mutation, host access, outbound write or LLM hop; the guide describes the family's existing confirmation gates.
Linked issues
Refs #1655
Notes for reviewers (optional)
Case 11 follows the requested contiguous numbering on current
main. PR #1673 independently adds another case 11; whichever lands second will need renumbering, fixture regeneration and count updates.If you would prefer a per-family
sections/welcome-pr-management.md(asked on the issue), I can add it.Review corrections: explicitly use
pr-triage's surface hash in the fixture, provide nine unique skill prompts, match the other guides' heading accents, and rename the shipping test totest_the_rules_section_and_all_guides_ship. The follow-up also repairs invalid JSON in the appliedstate.jsonsuggestion. A narrow spell-check exclusion covers SHA-256 fixturehashvalues.Validation evidence
Was generative AI tooling used to co-author this PR?
Generated-by: Codex (GPT-6)
The contributor has read every line of the diff and can answer review questions about it.