docs: add CHANGELOG, CONTRIBUTING, SECURITY + wiki link - #2
Merged
Conversation
Add the conventional governance/history files the repo lacked, and make the new GitHub Wiki discoverable from the README. - CHANGELOG.md: Keep a Changelog format, v0.1.0–v0.1.4 + Unreleased, reconstructed from the version-bump commit history (no tags yet; version links point at the shipping commit). - CONTRIBUTING.md: setup, the ruff+mypy+pytest gate, TDD + offline-determinism conventions; links to the wiki deep-dive. - SECURITY.md: private disclosure channel, supported-version = latest main, and the local-tool threat model. - README.md: CI/license/python badges + a Documentation → Wiki pointer. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Review-item follow-ups on this PR, both found by auditing the links rather than the prose. Dead wiki deep-links: CHANGELOG linked "How the Guards Evolved" and CONTRIBUTING linked "Development & Testing" (x2) and "Trust & Evaluation". None of those pages exist -- the wiki is a 31-byte "Welcome to the tearsheet wiki!" and Phase A hasn't started. Merging as written would have shipped four 404s. Repointed at what exists today: README's Trust / Development / Limitations sections and evals/README.md. The wiki root link stays (it resolves) and is now described as in progress. README's documentation pointer claimed full install, CLI reference, architecture, the guard/raw contract and troubleshooting "live in the Wiki". All of that is in this README. Corrected to say so. SECURITY.md offered GitHub private vulnerability reporting as the preferred channel, hedged "(if enabled on this repo)" -- and it was NOT enabled, which quietly made the maintainer's personal email the only working disclosure route. Private vulnerability reporting is now enabled on the repo, so the hedge is gone and the preferred path is real. Gate green: ruff, mypy (16 files), 243 passed / 6 deselected. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Adds the conventional governance/history files the repo was missing, and makes the new GitHub Wiki discoverable from the README. Companion to the wiki being authored separately.
What's here
v0.1.0–v0.1.4+[Unreleased], reconstructed from the version-bump commit history. No git tags exist yet, so version links point at the shipping commit rather than a release tag.ruff + mypy + pytestgate, TDD + offline-determinism conventions, and the "guards answer to real probation fixtures" rule. Links into the wiki Development & Testing page for depth.main, and the local-tool threat model (arbitrary-URL fetch, headless Chromium, untrusted HTML/PDF parsing,~/.tearsheetwrites).Verification
ruffclean,mypyclean (16 files), 243 passed / 6 deselected.Notes for review
git logand cross-checked against the version-bump commit bodies./wiki/...) resolve once the wiki pages are published.🤖 Generated with Claude Code