Skip to content

docs(readme): link Project files table to docs/, CHANGELOG, SECURITY (RAN-64) #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aksOps merged 1 commit into from
Apr 26, 2026
Merged

docs(readme): link Project files table to docs/, CHANGELOG, SECURITY (RAN-64) #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading