docs: add a worked 'author a new case' walkthrough to CONTRIBUTING - #30
Merged
Merged
Conversation
CONTRIBUTING jumped from Setup to Good first issues with no guidance on adding a case, so a contributor had to reverse-engineer cases.py. Add an 'Author a new case' section with a copy-pasteable leak-case spec (verified to build), the spec fields, the on-path rule (the date lives only in the injected email, never in user_task), the utility-keyword rule, the gap-case decoy guard (4 secrets, no decoy carries the canary), and the verify commands. Links docs/DESIGN.md. Docs only. Closes bamdadd#11
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
3 participants
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.
Closes #11.
CONTRIBUTING.mdjumped from Setup straight to Good first issues, so adding a case meant reverse-engineeringcases.py. This adds an Author a new case section:_build(family="delayed", canary_where="onpath", secrets=[], **spec)),{canary}/{attacker}are substituted,onpath_body, never inuser_task(else the injection is off-path),keywordmust be intitle),leakgauge --model stub:demo --suite all+pytest), which I ran — every case builds.Links docs/DESIGN.md. No source changes.