docs(education): add hands-on build-and-eval workshop#717
Open
justinmclean wants to merge 1 commit into
Open
Conversation
Adds docs/education/workshops.md as a self-serve, hands-on workshop. In about 90 minutes the reader builds one concrete skill (dependency-licence-check) end to end: scaffold it, write a two-step body that follows the data-not-instructions, propose-confirm-act, and placeholder rules, give it an eval suite with a normal case and a prompt-injection case, then run and harden it. Each exercise carries a learning objective, a done-checkpoint, and a self-check. This is an actual workshop in the shape the maintainer-education spec calls for (learning objectives, hands-on exercises, self-checks), not office-hours or pairing-session material. It presumes no PMC decision on cadence, hosting, or recordings: it ships the exercise, not a schedule. Follows the education house style (SPDX header, Words-used glossary, flat H2), stays project-agnostic with placeholders (PRINCIPLE 12), and lands under Apache-2.0 (PRINCIPLE 17). Commands and the eval-fixture layout were verified against the repo. Generated-by: Claude (Opus 4.8)
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
1 participant
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
Adds docs/education/workshops.md as a self-serve, hands-on workshop. In about 90 minutes the reader builds one concrete skill (dependency-licence-check) end to end: scaffold it, write a two-step body that follows the data-not-instructions, propose-confirm-act, and placeholder rules, give it an eval suite with a normal case and a prompt-injection case, then run and harden it. Each exercise carries a learning objective, a done-checkpoint, and a self-check.
This is an actual workshop in the shape the maintainer-education spec calls for (learning objectives, hands-on exercises, self-checks), not office-hours or pairing-session material. It presumes no PMC decision on cadence, hosting, or recordings: it ships the exercise, not a schedule.
Follows the education house style (SPDX header, Words-used glossary, flat H2), stays project-agnostic with placeholders (PRINCIPLE 12), and lands under Apache-2.0 (PRINCIPLE 17). Commands and the eval-fixture layout were verified against the repo.
Generated-by: Claude (Opus 4.8)
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)