Skip to content

Commit 5b0fdbb

Browse files
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 <noreply@paperclip.ing>
1 parent f59ede6 commit 5b0fdbb

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,11 +165,17 @@ Drives a real off-screen preview window via `-TestAction`. Coverage:
165165

166166
## Project files
167167

168-
| File | Purpose |
168+
| File / folder | Purpose |
169169
|---|---|
170170
| `SnipIT.ps1` | The whole app |
171171
| `Test-SnipIT.ps1` | 40 unit tests, no dependencies |
172172
| `Test-SnipIT-Interactive.ps1` | 42 WPF integration tests, no dependencies |
173+
| [`docs/`](docs/) | Long-form docs (design mocks, deeper write-ups). [`docs/README.md`](docs/README.md) is the index. |
174+
| [`CHANGELOG.md`](CHANGELOG.md) | Per-merge change history ([Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format). |
175+
| [`SECURITY.md`](SECURITY.md) | Vulnerability disclosure policy + supported versions. |
176+
| [`CLAUDE.md`](CLAUDE.md) | Agent / contributor brief — build, test, run, conventions, OpenSSF Scorecard baseline. |
177+
| [`shared/runbooks/engineering-standards.md`](shared/runbooks/engineering-standards.md) | PowerShell variant of the company-canonical engineering-standards runbook. |
178+
| [`.bestpractices.json`](.bestpractices.json) | OpenSSF Best Practices self-assessment (project [12647](https://www.bestpractices.dev/en/projects/12647)). |
173179
| `LICENSE` | MIT |
174180

175181
## Roadmap

0 commit comments

Comments
 (0)