Thanks for your interest in contributing to my projects. Please read this before submitting your contribution.
I use Bun or pnpm depending on the project. I recommend installing @antfu/ni so you don't need to worry about package managers when switching projects.
| Step | Command |
|---|---|
| 1. Install Node.js LTS | - |
| 2. Enable Corepack | corepack enable |
| 3. Install Bun | curl -fsSL https://bun.sh/install | bash |
| 4. Install @antfu/ni | npm i -g @antfu/ni |
| 5. Install dependencies | ni |
| 6. Install git hooks | nlx lefthook install |
With ni: ni = install, nr = run, nlx = execute. It auto-detects the package manager from lockfile.
| Command | Description |
|---|---|
nr dev |
Start dev server/environment |
nr build |
Build for production |
nr test |
Run tests (Vitest or Bun test) |
nr test --watch |
Run tests in watch mode |
nr lint |
Lint and format check |
nr lint:fix |
Auto-fix lint/format issues |
nr typecheck |
Type check with tsc/tsgo |
Run bare nr to see all available scripts.
I use Vitest or Bun's built-in test runner. Filter tests: nr test foo. Run once: nr test --run. UI mode: nr test --ui.
I use Biome for linting and formatting (often via ultracite). Biome handles JS/TS, JSON, and more in a single fast tool.
No Prettier - Biome handles formatting. Disable Prettier in your editor for these projects.
Most projects use Lefthook for pre-commit hooks that auto-format staged files.
Use VS Code or your preferred fork with the Biome extension. Projects include .vscode/settings.json for format-on-save.
Open an issue before starting significant work. Helps align on design and saves time.
I use Conventional Commits:
feat:- new featuresfix:- bug fixesdocs:- documentation onlychore:- maintenance, deps, etc.
Only fix: and feat: appear in changelogs. Use docs: fix typo not fix: typo
- PR title follows commit convention
- Link issues:
fix #123in description - Multiple commits fine - I squash merge
If new to PRs, see GitHub's guide.
Some projects use Turborepo for monorepo management.