From 5b0fdbbb7c34252ea4eafeebe8feafe16b732266 Mon Sep 17 00:00:00 2001 From: Amit Kumar Date: Sun, 26 Apr 2026 04:09:12 +0000 Subject: [PATCH] docs(readme): link Project files table to docs/, CHANGELOG, SECURITY (RAN-64) Closes the "README links to it" item on RAN-64. PR #4 already added CHANGELOG.md and docs/README.md to satisfy the bestpractices.dev release_notes + documentation_basics autofill criteria; this follow-up makes the new files discoverable from the top-level README so a human reader landing on the repo finds them without spelunking the file tree. Co-Authored-By: Paperclip --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 982ffc2..202525f 100644 --- a/README.md +++ b/README.md @@ -165,11 +165,17 @@ Drives a real off-screen preview window via `-TestAction`. Coverage: ## Project files -| File | Purpose | +| File / folder | Purpose | |---|---| | `SnipIT.ps1` | The whole app | | `Test-SnipIT.ps1` | 40 unit tests, no dependencies | | `Test-SnipIT-Interactive.ps1` | 42 WPF integration tests, no dependencies | +| [`docs/`](docs/) | Long-form docs (design mocks, deeper write-ups). [`docs/README.md`](docs/README.md) is the index. | +| [`CHANGELOG.md`](CHANGELOG.md) | Per-merge change history ([Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format). | +| [`SECURITY.md`](SECURITY.md) | Vulnerability disclosure policy + supported versions. | +| [`CLAUDE.md`](CLAUDE.md) | Agent / contributor brief — build, test, run, conventions, OpenSSF Scorecard baseline. | +| [`shared/runbooks/engineering-standards.md`](shared/runbooks/engineering-standards.md) | PowerShell variant of the company-canonical engineering-standards runbook. | +| [`.bestpractices.json`](.bestpractices.json) | OpenSSF Best Practices self-assessment (project [12647](https://www.bestpractices.dev/en/projects/12647)). | | `LICENSE` | MIT | ## Roadmap