docs: add SECURITY.md, ADRs, Mermaid diagram, and security badge#31
Merged
Conversation
Add SECURITY.md with supported-version policy, private vulnerability reporting via the Security tab, and in/out-of-scope classification. Add docs/decision-records/0001 (standalone stdlib-only scripts) and 0002 (pull-based manifest-driven template sync), capturing decisions already shipped and reasoned in PLAN.md. Add docs/diagrams/qa-template-sync-flow.mmd showing the QA and template-sync flow from scripts/ through auto-release to downstream sync PRs. Add Security Policy badge to the README badge row alongside the existing CI, Coverage, Python, Platform, and License badges. Update .gitignore allowlist to track SECURITY.md and the new docs/ directory tree.
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.
Summary
v1tag), private vulnerability reporting via the GitHub Security tab, response-timeline table, and in/out-of-scope classification (scripts, workflows, reference configs; excludes upstream third-party tools).scripts/throughauto-release.yml→ release tag →self-update.yml→ downstream sync PR →python-qa.ymlreusable workflow.SECURITY.mdand the newdocs/directory tree (deny-all model requires explicit allowlisting of every new path).Test plan
.mdfiles (verified locally: 0 errors)git status --short(verified: no files ignored)template-ci.yml) passes on the PR