Skip to content

chore(repo): add commit-hygiene guard, keep internal notes out of git#44

Open
ozpool wants to merge 1 commit into
mainfrom
chore/43-repo-hygiene
Open

chore(repo): add commit-hygiene guard, keep internal notes out of git#44
ozpool wants to merge 1 commit into
mainfrom
chore/43-repo-hygiene

Conversation

@ozpool
Copy link
Copy Markdown
Owner

@ozpool ozpool commented May 29, 2026

Summary

Keeps the repo professional: internal planning/review notes can no longer be committed, enforced automatically by a pre-commit gate. Also removes the internal planning docs that were committed in the genesis foundation and trims planning-iteration voice from the design docs.

Refs #43

Changes

  • scripts/check-repo-hygiene.sh — pre-commit gate that blocks staging internal-only files (planning notes, review findings, drafts, scratch, local files, dotenv files); warns on large blobs
  • Wired into .husky/pre-commit
  • Removed docs/planning/* (originals kept outside the repo; issues already live in GitHub Issues)
  • Trimmed planning headers in docs/ARCHITECTURE.md + docs/ENGINEERING.md
  • README links the roadmap (milestones/issues) instead of the removed planning doc

Test plan

  • Guard blocks new docs/planning/**, *FINDINGS*.md, *.draft.md, scratch/**, *.local.*
  • Guard passes real files (README, src, .env.example)
  • Deletions are not blocked (legit removals pass)
  • Manual verification by reviewer

Risk

Low — tooling + doc removal only, no code paths touched. Reverts cleanly in one PR.

Checklist

  • PR title follows Conventional Commits
  • No secrets, no env files committed
  • No debug code
  • Docs updated

Junior note: parked for your review — I won't merge or close. The genesis issues (#1/#2/#3/#5) are reopened pending your review too.

Add scripts/check-repo-hygiene.sh (run from the pre-commit hook) that blocks
staging internal-only files: planning notes, review findings, drafts, scratch,
and local files. Remove the internal planning and findings docs that should
not live in the repo, and trim planning-iteration voice from the architecture
and engineering docs.

Refs #43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant