Skip to content

docs(education): add maintainer pattern catalogue#714

Merged
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-pattern-catalogue
Jul 4, 2026
Merged

docs(education): add maintainer pattern catalogue#714
potiuk merged 1 commit into
apache:mainfrom
justinmclean:education-pattern-catalogue

Conversation

@justinmclean

Copy link
Copy Markdown
Member

Summary

Ten copy-pasteable skill / prompt / tool-use patterns with war stories (what worked, what did not, and why), drawn from the framework's own skill history. Covers: propose-confirm-act loop, external-content-is-data defence, fetch-all/classify-all/present-groups, placeholder convention, privacy routing, skill composition, read-fresh-then-write, eval discipline, golden-rules preamble, and adopter overrides. Distinct from the PII redaction reference at tools/privacy-llm/pii.md.

Generated-by: Claude (Opus 4.7)

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:

Ten copy-pasteable skill / prompt / tool-use patterns with war stories
(what worked, what did not, and why), drawn from the framework's own
skill history. Covers: propose-confirm-act loop, external-content-is-data
defence, fetch-all/classify-all/present-groups, placeholder convention,
privacy routing, skill composition, read-fresh-then-write, eval discipline,
golden-rules preamble, and adopter overrides. Distinct from the PII
redaction reference at tools/privacy-llm/pii.md.

Generated-by: Claude (Opus 4.7)
@justinmclean justinmclean self-assigned this Jul 3, 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.

LGTM — self-contained new docs page (docs/education/pattern-catalogue.md). SPDX header present, doctoc TOC matches headings, outbound links all resolve, placeholder-clean, no emojis. This is the one education-stream page that doesn't touch the shared README.md/index.md, so it carries no merge-order coupling with #713/#715/#716. CI green.

@potiuk
potiuk merged commit 55e421b into apache:main Jul 4, 2026
34 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