docs(setup): add personal-use-unadopted-repo how-to recipe#851
Merged
potiuk merged 1 commit intoJul 13, 2026
Merged
Conversation
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)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
.claude/skills/<name>/) — eval fixtures updated belowtools/<system>/*.md)tools/*/withpyproject.toml)docs/,README.md,CONTRIBUTING.md)projects/_template/)prek, workflows, validators)Test plan
prek run --all-filespassesuv run pytest/ruff check/mypypasses(
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)
RFC-AI-0004 compliance
<PROJECT>,<tracker>,<upstream>,<security-list>) used in all skill / tool prose (thecheck-placeholdersprek hook is the mechanical gate)Linked issues
Notes for reviewers (optional)