Skip to content

docs(bestpractices): CHANGELOG + docs/ folder closes audit blockers (RAN-55)#3

Merged
aksOps merged 1 commit intomainfrom
chore/ran-55-changelog-docs
Apr 26, 2026
Merged

docs(bestpractices): CHANGELOG + docs/ folder closes audit blockers (RAN-55)#3
aksOps merged 1 commit intomainfrom
chore/ran-55-changelog-docs

Conversation

@aksOps
Copy link
Copy Markdown
Contributor

@aksOps aksOps commented Apr 26, 2026

Summary

Closes the last two Unmet blockers from the bestpractices.dev/projects/12648 audit posted on RAN-55.

Audit blocker Fix
release_notes Unmet New CHANGELOG.md (Keep a Changelog 1.1.0) with [Unreleased] cataloguing PR #1 changes
documentation_basics Unmet ("No appropriate folder found") New docs/ folder with index + architecture + install + troubleshooting + security

.bestpractices.json is updated to flip both criteria from N/A/Unmet to Met and add *_url pointers.

Test plan

  • python3 -c "import json; json.load(open('.bestpractices.json'))" clean
  • All cross-references resolve (relative links between docs/*.md, README.md, CLAUDE.md, SECURITY.md, CHANGELOG.md)
  • Watch CI run on this PR — Semgrep / Trivy / Gitleaks / jscpd / SBOM / Scorecard from .github/workflows/security.yml and scorecard.yml
  • After merge, re-run the bestpractices.dev autofill so release_notes, release_notes_vulns, and documentation_basics flip to Met on the live page

Files

  • CHANGELOG.md — new, root-level
  • docs/README.md, docs/architecture.md, docs/install.md, docs/troubleshooting.md, docs/security.md — new
  • .bestpractices.jsonrelease_notes + release_notes_vulns (N/AMet, URLs added); documentation_basics_url added

Refs RAN-55, RAN-60.

🤖 Generated with Claude Code

…a (RAN-55)

Closes the last two `Unmet` blockers from the bestpractices.dev/projects/12648
audit (board comment on RAN-55):

- `release_notes` Unmet → Met. Add CHANGELOG.md (Keep a Changelog 1.1.0
  format) with an [Unreleased] section that catalogues what landed in PR
  #1: OpenSSF scaffolding, OSV-Scanner CI fix, debounced-search-on-close
  fix, deep-review fixes, LICENSE attribution, Security adoption notes.
  Pre-1.0 the commit SHA on `main` is the version identifier; the
  [Unreleased] block rolls into a versioned heading when the first tag
  is cut.

- `documentation_basics` Unmet ("No appropriate folder found") → Met.
  Add docs/ folder with: docs/README.md (index), docs/architecture.md
  (5-phase startup, repo shape, runtime invariants, stack), docs/install.md
  (requirements, run + flags, tests, update path), docs/troubleshooting.md
  (preflight bitmap, CLM / AppLocker / EDR blockers, DPAPI store recovery),
  docs/security.md (threat model, hardened invariants, crypto, distribution
  integrity).

- Update .bestpractices.json:
    * documentation_basics_status: Met (now backed by docs/ folder; URL
      added pointing at the tree)
    * release_notes_status: N/A → Met (URL added pointing at CHANGELOG.md)
    * release_notes_vulns_status: N/A → Met (URL added pointing at
      CHANGELOG.md#security)

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@aksOps aksOps merged commit 562f1c4 into main Apr 26, 2026
10 checks passed
aksOps added a commit that referenced this pull request Apr 26, 2026
Cuts the first tagged release line for vigil and rolls in the audit fixes that didn't make it into PR #3's squash. CHANGELOG.md gains the [0.1.0] section + SemVer preamble; .bestpractices.json fills in v0.1.0 evidence and flips version_semver / version_tags / test_continuous_integration to Met.

Closes [RAN-55](/RAN/issues/RAN-55) audit-fix portion. Tag + GitHub Release tracked under [RAN-67](/RAN/issues/RAN-67).
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