Skip to content

docs(setup): add personal-use-unadopted-repo how-to recipe#851

Merged
potiuk merged 1 commit into
apache:mainfrom
justinmclean:howto-personal-use-unadopted-repo
Jul 13, 2026
Merged

docs(setup): add personal-use-unadopted-repo how-to recipe#851
potiuk merged 1 commit into
apache:mainfrom
justinmclean:howto-personal-use-unadopted-repo

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

A docs/setup/ recipe for contributors who want to run Magpie skills against a project that has not adopted the framework, without committing artefacts or requiring teammates to opt in.

Covers the four-step flow: whole-user install (clone the framework and symlink all skills to ~/.claude/skills/ for user-scope availability), add one .gitignore line to keep .apache-magpie-local/ untracked, create the personal config directory (with optional override files), and invoke skills as normal. Includes a what-works / what-doesn-not table and migration guidance for when the target project later adopts.

Also links the new page from docs/setup/README.md under Deep documentation.

Note: depends on magpie-local-convention being merged first.

Generated-by: Claude (claude-sonnet-4-6)

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:

Test plan

  • [X ] 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:

RFC-AI-0004 compliance

  • HITL — any new mutation is gated on explicit user confirmation
  • Sandbox — no new unrestricted host access; network reach declared in the adapter
  • Vendor neutrality — placeholders (<PROJECT>, <tracker>, <upstream>, <security-list>) used in all skill / tool prose (the check-placeholders prek hook is the mechanical gate)
  • Conversational + correctable — agentic-override path documented if behaviour is adopter-tunable
  • Write-access discipline — no autonomous outbound messages; drafts only, sent on confirmation
  • Privacy LLM — private content does not reach a non-approved LLM; redactor invoked where needed

Linked issues

Notes for reviewers (optional)

A `docs/setup/` recipe for contributors who want to run Magpie skills
against a project that has not adopted the framework, without committing
artefacts or requiring teammates to opt in.

Covers the four-step flow: whole-user install (clone the framework and
symlink all skills to ~/.claude/skills/ for user-scope availability),
add one .gitignore line to keep .apache-magpie-local/ untracked,
create the personal config directory (with optional override files), and
invoke skills as normal. Includes a what-works / what-doesn-not table
and migration guidance for when the target project later adopts.

Also links the new page from docs/setup/README.md under Deep
documentation.

Note: depends on magpie-local-convention being merged first.

Generated-by: Claude (claude-sonnet-4-6)
@justinmclean justinmclean self-assigned this Jul 13, 2026

@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.

Good idea :)

@potiuk potiuk merged commit fffbde9 into apache:main Jul 13, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants