Skip to content

docs: add SECURITY.md, ADRs, Mermaid diagram, and security badge#31

Merged
NWarila merged 1 commit into
mainfrom
chore/portfolio-alignment-v1
Jun 2, 2026
Merged

docs: add SECURITY.md, ADRs, Mermaid diagram, and security badge#31
NWarila merged 1 commit into
mainfrom
chore/portfolio-alignment-v1

Conversation

@NWarila

@NWarila NWarila commented Jun 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • SECURITY.md: Adds supported-version policy (latest release / v1 tag), 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).
  • docs/decision-records/0001: Captures the already-shipped decision that QA scripts are standalone and stdlib-only — no shared helper module, no third-party imports. Converts reasoning from PLAN.md Resolved Decision 14.
  • docs/decision-records/0002: Captures the already-shipped decision to use pull-based, manifest-driven template sync instead of push-based cross-repo credentials or git submodules. Converts reasoning from PLAN.md Resolved Decision 22 and the PR refactor: replace push-based sync with pull-based reusable workflow #4 refactor.
  • docs/diagrams/qa-template-sync-flow.mmd: Mermaid flowchart of the QA and template-sync flow — from scripts/ through auto-release.yml → release tag → self-update.yml → downstream sync PR → python-qa.yml reusable workflow.
  • README.md: Adds a Security Policy badge alongside the existing CI, Coverage, Python, Platform, and License badges.
  • .gitignore: Adds allowlist entries for SECURITY.md and the new docs/ directory tree (deny-all model requires explicit allowlisting of every new path).

Test plan

  • markdownlint passes on all new and modified .md files (verified locally: 0 errors)
  • All new files appear as tracked in git status --short (verified: no files ignored)
  • No AI bylines, Co-authored-by trailers, or "generated by" text in files or commit message (verified via grep)
  • CI (template-ci.yml) passes on the PR

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.
@NWarila NWarila merged commit 102baa5 into main Jun 2, 2026
13 checks passed
@NWarila NWarila deleted the chore/portfolio-alignment-v1 branch June 2, 2026 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant