Skip to content

feat(setup): add mentoring family first-run welcome guide - #1708

Merged
potiuk merged 4 commits into
apache:mainfrom
KatalKavya96:docs/mentoring-welcome-guide
Oct 19, 2026
Merged

potiuk merged 4 commits into
apache:mainfrom
KatalKavya96:docs/mentoring-welcome-guide

Conversation

@KatalKavya96

Copy link
Copy Markdown
Contributor

Summary

  • Add a first-run welcome guide for the Mentoring family, covering welcome, good-first-issue-sweep, good-first-issue-author, and newcomer-issue-explainer, helping maintainers discover the available workflows and get started through natural-language requests.
  • Document required and optional configuration, personal setup versus project adoption, and explicit maintainer confirmation before posting comments, creating issues, or applying labels.
  • Link the guide from the Mentoring README, add first-run regression tests and a preflight-floor evaluation fixture, regenerate affected welcome reports, and update evaluation case counts.

Type of change

  • Skill change (.claude/skills/<name>/) — eval fixtures updated below
  • Tool / bridge contract (tools/<system>/*.md)
  • Python package (tools/*/ with pyproject.toml)
  • Groovy reference impl
  • Cross-cutting (RFC, AGENTS.md, sandbox, privacy-LLM)
  • Documentation (docs/, README.md, CONTRIBUTING.md)
  • Project template (projects/_template/)
  • CI / dev loop (prek, workflows, validators)
  • Other: Setup-preflight welcome guide and first-run evaluation coverage

Test plan

  • prek run --all-files passes
  • For Python packages touched: uv run pytest / ruff check / mypy passes
  • For Groovy bridges touched: command-line invocation tested end-to-end
  • For skill changes: eval suite passes for the affected skill
    (PYTHONPATH=tools/skill-evals/src python3 -m skill_evals.runner tools/skill-evals/evals/<skill>/)
  • For skill behaviour changes: a new or updated eval fixture is included in this PR
    (a regression test for the bug fixed / the behaviour added — see CONTRIBUTING.md)
  • Other:
    • Setup-preflight welcome regression tests passed.
    • Preflight fixture reports regenerated and verified with render-preflight-fixtures.py --check.
    • Rendered Mentoring guide verified against the 70-line limit.
    • git diff --check passed.
    • Repository-wide pytest, Ruff, mypy, documentation synchronization, and validators passed through prek.

RFC-AI-0004 compliance

  • HITL — maintainer confirmation is required before posting comments, creating issues, or applying labels.
  • Sandbox — no new unrestricted host access or runtime permissions introduced.
  • Vendor neutrality — project-specific values are resolved through configuration; existing placeholder conventions remain unchanged.
  • Conversational + correctable — natural-language examples and the customization workflow are documented.
  • Write-access discipline — mentoring skills draft first and require explicit confirmation before publishing.
  • Privacy LLM — not affected by this change.

Linked issues

Closes #1659

Refs #1654

Notes for reviewers (optional)

AI assistance disclosure: AI assistance was used for repository analysis, implementation drafting, and review. Changes were applied and validated locally by the contributor.

@github-actions github-actions Bot added family:setup setup-* skills family:tools tools/* family:docs Docs, MISSION.md, READMEs capability:platform Framework / agent substrate skills (install, verify, doctor, override, status, setup bootstrap) family:mentoring mentoring skills substrate:framework-dev Tool substrate: build / validate / eval the framework itself substrate:setup Tool substrate: adopter-side setup state resolved at runtime (lock parsing, floors, fingerprints) labels Oct 19, 2026
@KatalKavya96

Copy link
Copy Markdown
Contributor Author

Hi @potiuk,

I've implemented the Mentoring family welcome guide for #1659, following the established pattern from #1669.

It covers all four mentoring skills, their configuration requirements, example workflows, and maintainer confirmation boundaries. I've also added the README link, first-run evaluation fixture, and regression tests.

All repository-wide checks passed locally with prek run --all-files.
Thanks!

@Kaap10 Kaap10 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @KatalKavya96 for adding the mentoring family welcome guide!

Tested locally — the guide rendering looks clean, test_welcome.py passes all 51 tests across all four mentoring skills, render-preflight-fixtures.py --check passes with zero drift, and the case counts in the evals READMEs are updated consistently.

Left one inline suggestion on docs/mentoring/README.md regarding layout consistency with other family READMEs (security, utilities, contributor-growth). Other than that, everything looks solid!

Comment thread docs/mentoring/README.md Outdated
KatalKavya96 and others added 3 commits October 19, 2026 20:26
…ate"

The mentoring welcome guide said existing welcomes and handled threads
"are skipped as appropriate", which leaves a newcomer guessing what is
skipped. Name it outright, and re-render the case-11 fixture that
embeds the guide.

Generated-by: Claude Opus 5

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adds the mentoring-family first-run welcome guide in the same shape as the utilities and security guides, with matching tests, a preflight-floor eval case and the README pointer; the content checks out against the four mentoring skills and their config files.

I pushed one small fixup commit (aea0177) rather than leave a nit for another round trip: the guide said existing welcomes and handled threads "are skipped as appropriate", which leaves a newcomer guessing what actually gets skipped. It now reads "Contributors who were already welcomed, and threads already handled, are skipped.", and the case-11-mentoring-first-run report that embeds the guide is re-rendered to match. Thanks for the guide!


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.

@potiuk
potiuk merged commit d4fb60e into apache:main Oct 19, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

capability:platform Framework / agent substrate skills (install, verify, doctor, override, status, setup bootstrap) family:docs Docs, MISSION.md, READMEs family:mentoring mentoring skills family:setup setup-* skills family:tools tools/* substrate:framework-dev Tool substrate: build / validate / eval the framework itself substrate:setup Tool substrate: adopter-side setup state resolved at runtime (lock parsing, floors, fingerprints)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Welcome guide: mentoring family

3 participants