A documentation and tooling template for software projects with AI-assisted onboarding — Claude prompts, decision records (ADR/AIR/AID/RFC), git conventions, and release automation ready to use.
| Area | What you get |
|---|---|
| Git workflow | Branch naming rules, commit format (Conventional Commits), PR process |
| Git hooks | Lefthook: pre-commit (format + lint), commit-msg (commitlint), pre-push |
| Release cycle | Release-it: version bump, CHANGELOG generation, GitHub Release publishing |
| Decision records | ADR, AIR, AID, RFC — all with templates, indexes, and archive |
| Documentation | Architecture, guides, checklists, glossary — structured and linked |
| AI prompts | Claude prompts for generating project-specific docs from a single onboarding run |
| Project memory | docs/context/ — persistent context readable by Claude and humans |
| Init wizard | pnpm run init — installs tools, hooks, .env, git template in one command |
| Status wizard | pnpm start — shows project status and recommends the next step |
| CI/CD | GitHub Actions: lint, format check, link check, Renovate, Dependabot |
pnpm run init
The script automatically:
- Checks and installs required global tools (commitlint, release-it, prettier, markdownlint-cli2)
- Installs local pnpm dependencies (lefthook)
- Installs git hooks
- Creates
.envfrom.env.example - Configures git commit message template
| Secret | Purpose | How to get |
|---|---|---|
RENOVATE_TOKEN |
Renovate opens dependency PRs | GitHub PAT with repo + workflow scopes |
GITHUB_TOKEN |
release-it publishes GitHub Releases | Auto-provided by GitHub Actions (enable write permissions) |
Open a new Claude session and paste the contents of docs/prompts/onboarding.md.
Claude will ask a few questions and generate all project-specific documents.
pnpm start
| Command | Description |
|---|---|
pnpm start |
Show project status and next recommended step |
pnpm run init |
Full project initialization (run once after clone) |
pnpm run lint:fix |
Auto-fix markdownlint issues |
pnpm run lint:check |
Check markdown without fixing |
pnpm run lint |
Fix then check (combined) |
pnpm run format:fix |
Format all files with Prettier |
pnpm run format:check |
Check formatting without making changes |
pnpm run format |
Fix then check (combined) |
npm run release:dry |
Preview release — no changes made |
npm run release:patch |
Release patch version bump |
npm run release:minor |
Release minor version bump |
npm run release:major |
Release major version bump |
Use
npm runfor release commands (notpnpm run) to avoid ELIFECYCLE noise.
| Document | Description |
|---|---|
| AGENTS.md | Guide for AI agents working in this repo |
| docs/glossary/glossary.md | Definitions of all terms used across the project |
| docs/guides/onboarding.md | Getting started for new team members |
| docs/guides/git-workflow.md | Branch naming, commit format, PR flow |
| docs/guides/code-review.md | Code review principles and what to check |
| docs/guides/release-flow.md | Release process and commands |
| docs/guides/docs-style-guide.md | How to write documentation in this project |
| docs/guides/git-config.md | One-time local git setup |
| docs/guides/updating-dependencies.md | Renovate + Dependabot workflow |
| docs/adr/INDEX.md | ADR — Architecture Decision Records |
| docs/air/INDEX.md | AIR — Architecture Issue Records |
| docs/aid/INDEX.md | AID — AI Interaction Documents |
| docs/rfc/INDEX.md | RFC — Requests for Comments (pre-decision proposals) |
| docs/checklists/new-project.md | Master checklist for setting up a new project |
| docs/checklists/code-review.md | Pre-approve checklist for reviewers |
| docs/checklists/release.md | Combined human + AI release checklist |
| docs/checklists/new-feature.md | Combined human + AI new feature checklist |
| docs/prompts/ | Claude prompts for generating project docs |
| CHANGELOG.md | Release history |
| ROADMAP.md | Planned milestones |
| Tool | Author | Purpose |
|---|---|---|
| Lefthook | Evil Martians | Git hooks manager |
| commitlint | @conventional-changelog | Commit message validation |
| release-it | @release-it | Release automation |
| Prettier | @prettier | Code formatter |
| markdownlint-cli2 | @DavidAnson | Markdown linter |
| Renovate | @renovatebot | Automated dependency updates |