Skip to content

docs: add CLAUDE.md #2

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
almost486 merged 1 commit into from
May 25, 2026
+29 −0
Merged

docs: add CLAUDE.md #2

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
29 changes: 29 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading