docs: refresh README repository layout with drift guards - #13
Open
mattpartida wants to merge 1 commit into
Open
mattpartida wants to merge 1 commit into
mattpartida wants to merge 1 commit into
Conversation
The README repository-layout tree had drifted from disk: it omitted docs/, examples/policies/, examples/schema-adapters/, the prompt-sarif and compare-reports CI workflow examples, the combined boundary report, scripts/, and package-skills.sh. Adds tests/test_readme_repository_layout.py so the tree cannot drift again in either direction: - every concrete path named in the tree must exist on disk - every examples/ci/github-actions/*.yml workflow must be listed - core top-level entries stay listed - tree rows stay parseable (spaces-only indentation, glob-or-plain names) Documentation-only change; no scanner, rule, or packaging behavior changed. dist artifacts remain byte-identical.
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
Backlog item 9 (stale README/docs). The README
Repository layouttree had drifted from disk — it omitteddocs/,examples/policies/,examples/schema-adapters/, theagent-security-prompt-sarif.ymlandagent-security-compare-reports.ymlworkflow examples, the combined boundary report,scripts/, andpackage-skills.sh.This PR refreshes the tree and adds
tests/test_readme_repository_layout.pyso it cannot drift again in either direction:examples/ci/github-actions/*.ymlworkflow must be listed — new integration examples will fail CI until documented.skills/,docs/,tests/,scripts/,examples/,package-skills.sh,.github/workflows/stay listed.Documentation-only: no scanner, rule, CLI, or packaging behavior changed; JSON output fields unchanged;
dist/artifacts remain byte-identical. Abbreviated glob entries (*.json,test_*.py,*.txt / *.json) are skipped by existence checks so the tree stays compact.Deliberately scoped to avoid overlap with open PRs #8/#10/#12 (they touch README usage sections and CHANGELOG bullets, not the layout tree).
Test plan
uv run --python 3.11 --with pytest pytest -q→ 151 passed (147 on main + 4 new)ruff check .→ clean;ruff format --checkon the new test → cleanpython3.11 -m compileall -q skills tests scripts→ OK./package-skills.sh+python3.11 scripts/package_skills.py --check→ artifacts current and reproduciblegit diff --check→ clean