Skip to content

docs(setup): add mixed-adoption-teams how-to recipe#853

Merged
potiuk merged 1 commit into
apache:mainfrom
justinmclean:howto-mixed-adoption-teams
Jul 13, 2026
Merged

docs(setup): add mixed-adoption-teams how-to recipe#853
potiuk merged 1 commit into
apache:mainfrom
justinmclean:howto-mixed-adoption-teams

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Adds docs/setup/mixed-adoption-teams.md — the recipe for running Magpie on a shared repo when some teammates have not adopted the framework. Covers whole-user install, adding one .gitignore line, creating .apache-magpie-local/, running skills, what teammates see (nothing), what works vs what does not, skills that assume full adoption, and the transition path when the team later adopts.

Includes a probe note on skills that hard-fail without a committed project-config: the fix is either a local project.md override or an upstream gap report — not papering over the failure in the doc.

Validation: test -f docs/setup/mixed-adoption-teams.md passes.
skill-and-tool-validate: 27 SOFT warnings (advisory, pre-existing).
spec-validator: 87 tests pass.

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

  • 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:

Adds docs/setup/mixed-adoption-teams.md — the recipe for running
Magpie on a shared repo when some teammates have not adopted the
framework. Covers whole-user install, adding one .gitignore line,
creating .apache-magpie-local/, running skills, what teammates see
(nothing), what works vs what does not, skills that assume full adoption,
and the transition path when the team later adopts.

Includes a probe note on skills that hard-fail without a committed
project-config: the fix is either a local project.md override or an
upstream gap report — not papering over the failure in the doc.

Validation: test -f docs/setup/mixed-adoption-teams.md passes.
skill-and-tool-validate: 27 SOFT warnings (advisory, pre-existing).
spec-validator: 87 tests pass.

Generated-by: Claude (claude-sonnet-4-6)
@justinmclean justinmclean self-assigned this Jul 13, 2026
@potiuk potiuk merged commit ca5146f into apache:main Jul 13, 2026
9 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