Document the local checks and index the example packs (closes #31, closes #34) - #62
Merged
Conversation
kikashy
force-pushed
the
contributor-docs
branch
2 times, most recently
from
August 15, 2026 01:02
15556b5 to
0014a97
Compare
…oses #34) CONTRIBUTING.md gets a Local checks section: the Python version CI currently uses, the dependency install, and the test command, taken from the workflow rather than restated from memory. It also carries a warning I earned rather than invented. requirements-dev.txt pins jsonschema[format-nongpl], and the format keyword is only checked when those extras are installed. Without them jsonschema silently ignores format, so the two corpus cases that exist to prove a malformed URI and a malformed timestamp are rejected come back VALID and the suite passes while checking less than it claims. I spent this session treating that as ambient environment noise before finding the cause, which is exactly the confusion a first-time contributor would hit and have no way to diagnose. examples/README.md indexes the five synthetic packs. Each row names its domain and ONE feature genuinely worth opening that file for, derived by reading the documents rather than guessing: the only optional evidence requirement and the only attestation evidence; the clearest ordered comparisons plus a nested not; the evidence-light pack where rule structure carries the decision; two independent evidence-present conditions inside one all; and an exception alongside a not, which are worth reading together because they are not the same thing. Both carry the standing notice: synthetic and non-operational, not authorization or proof that a decision is safe, no real or sensitive data, and no fetching of example source locators during ordinary validation. Signed-off-by: kikashy <kikashy@hotmail.com>
kikashy
force-pushed
the
contributor-docs
branch
from
August 15, 2026 01:03
0014a97 to
660e79a
Compare
|
🎉 Thank you for your contribution to Judgment Pack! If you’d like another task, choose a path that interests you: |
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.
Closes #31. Closes #34.
Two onboarding documents, on separate files, neither touching code.
CONTRIBUTING.md— a Local checks sectionThe Python version CI currently uses (3.12, stated as what the workflow uses rather than a declared project minimum), the dependency install, and the test command — taken from
.github/workflows/conformance.ymlrather than restated from memory.It also carries a warning I earned rather than invented:
I spent most of a working session treating
2 failed, 45 errorsas ambient environment noise before finding the cause.structural-relative-pack-idandstructural-invalid-created-atwere returning valid. That is precisely the confusion a first-time contributor hits with no way to diagnose it, and it is worth four sentences in the contributor guide.examples/README.md— an index of the five packsA compact table linking each example once, naming its synthetic domain and one feature genuinely worth opening that file for. These were derived by reading the documents, not guessed:
attestationevidencein,greater-than,less-than-or-equal— plus a nestednotevidence-presentconditions inside oneallexceptionalongside anot, worth reading together because they are not the same thingWith links to
TESTING.md,docs/field-guide.mdand the schema, and the standing notice: synthetic and non-operational, not authorization or proof any decision is safe, no real or sensitive data, and no fetching of example source locators during ordinary validation.Suite:
64 passed, 529 subtests.🤖 Generated with Claude Code