From 273f8c490122cb31a16d8d2da3b1d72ee6376b08 Mon Sep 17 00:00:00 2001 From: _ryco <22485872+almost486@users.noreply.github.com> Date: Mon, 25 May 2026 16:09:58 -0400 Subject: [PATCH] docs: add CLAUDE.md with project context for Claude Code sessions Co-Authored-By: Claude Sonnet 4.6 --- CLAUDE.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..4077839 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,29 @@ +# GameVault-GamePrep + +PowerShell scripts that compress GOG/Steam game folders into `.7z` archives for [GameVault](https://gamevau.lt/). + +## Project Context + +- **Target platform:** Windows (PS 5.1+ or 7+); repo is edited on macOS +- **Two scripts:** `Prepare-GamesForGameVault.ps1` (interactive, prompts for metadata) · `Compress-ForGameVault.ps1` (batch, folders pre-named) +- **No automated tests** — scripts are validated manually on Windows +- **Large game directories are gitignored:** `GOG-Archive/`, `Steam-Archive/`, `GameVault-Ready/` + +## Setup (after clone) + +```bash +bash scripts/install-hooks.sh # sets core.hooksPath → scripts/hooks +``` + +Requires `gitleaks` installed (`brew install gitleaks`) for pre-commit secret scanning. + +## Security + +- Pre-commit hook: `gitleaks protect --staged` — runs on every commit +- CI: `gitleaks` GitHub Action on every push/PR +- GitHub Actions are pinned to commit SHAs (not tags) — keep this when adding/updating actions +- `GITHUB_TOKEN` permissions are scoped per-job — don't widen without reason + +## Code Review + +CodeRabbit is configured (`.coderabbit.yaml`) — auto-reviews PRs, chill profile.