Repository Guidelines

Project Structure & Module Organization

Each top‑level directory is a Stow “package” that maps into
```
$HOME
```
:
- ```
zsh/
```
  →
```
~/.zshrc
```
  ,
```
~/.aliases
```
  ,
```
~/.p10k.zsh
```
- ```
tmux/
```
  →
```
~/.tmux.conf
```
- ```
alacritty/
```
  ,
```
kitty/
```
  ,
```
nvim/
```
  → respective app configs
Root files:
```
README.md
```
,
```
Makefile
```
, and this guide.

Build, Test, and Development Commands

Install deps (macOS example):

brew install stow tmux neovim ripgrep fd

Using Makefile (preferred):
- ```
make stow
```
  — link all packages into
```
$HOME
```
- ```
make stow PACKAGES="zsh tmux"
```
  — link specific packages
- ```
make restow
```
  — reapply links after changes
- ```
make unstow
```
  — remove links
- ```
make verify
```
  — quick symlink check
Direct Stow examples (optional):
```
stow -t ~ zsh
```
,
```
stow -D -t ~ tmux
```

Coding Style & Naming Conventions

Shell/Zsh: 2‑space indentation, no tabs; prefer POSIX‑friendly snippets when possible.
Aliases/functions: lowercase with hyphens (e.g.,
```
touch-p
```
,
```
ngrok-host
```
).
Put app configs inside their package dir using dotfile names (e.g.,
```
zsh/.zshrc
```
).
Machine‑local overrides belong in untracked files like
```
~/.zshrc.local
```
and
```
~/.aliases.local
```
.

Testing Guidelines

After stowing, open a new shell; ensure no startup errors.

Tmux:

tmux

then

prefix + I

to install TPM plugins; or

~/.tmux/plugins/tpm/bin/install_plugins

Neovim/Alacritty/Kitty: launch the app to confirm themes and settings load.

Commit & Pull Request Guidelines

Use Conventional Commits:

feat:

fix:

docs:

chore:

refactor:

(avoid vague

wip

Examples:

feat(zsh): add zinit plugins

fix(tmux): correct 256‑color setting

PRs should include: purpose, affected packages, OS/terminal version, and before/after notes or screenshots if visual.

Security & Configuration Tips

Do not commit secrets, tokens, or machine‑specific absolute paths.
Guard optional tools (e.g., Homebrew) with checks as in
```
zsh/.zshrc
```
.
Prefer environment variables and local overrides to keep the repo portable.

Repository Guidelines

Project Structure & Module Organization

Each top‑level directory is a Stow “package” that maps into
```
$HOME
```
:
- ```
zsh/
```
  →
```
~/.zshrc
```
  ,
```
~/.aliases
```
  ,
```
~/.p10k.zsh
```
- ```
tmux/
```
  →
```
~/.tmux.conf
```
- ```
alacritty/
```
  ,
```
kitty/
```
  ,
```
nvim/
```
  → respective app configs
Root files:
```
README.md
```
,
```
Makefile
```
, and this guide.

Build, Test, and Development Commands

Install deps (macOS example):

brew install stow tmux neovim ripgrep fd

Using Makefile (preferred):
- ```
make stow
```
  — link all packages into
```
$HOME
```
- ```
make stow PACKAGES="zsh tmux"
```
  — link specific packages
- ```
make restow
```
  — reapply links after changes
- ```
make unstow
```
  — remove links
- ```
make verify
```
  — quick symlink check
Direct Stow examples (optional):
```
stow -t ~ zsh
```
,
```
stow -D -t ~ tmux
```

Coding Style & Naming Conventions

Shell/Zsh: 2‑space indentation, no tabs; prefer POSIX‑friendly snippets when possible.
Aliases/functions: lowercase with hyphens (e.g.,
```
touch-p
```
,
```
ngrok-host
```
).
Put app configs inside their package dir using dotfile names (e.g.,
```
zsh/.zshrc
```
).
Machine‑local overrides belong in untracked files like
```
~/.zshrc.local
```
and
```
~/.aliases.local
```
.

Testing Guidelines

After stowing, open a new shell; ensure no startup errors.

Tmux:

tmux

then

prefix + I

to install TPM plugins; or

~/.tmux/plugins/tpm/bin/install_plugins

Neovim/Alacritty/Kitty: launch the app to confirm themes and settings load.

Commit & Pull Request Guidelines

Use Conventional Commits:

feat:

fix:

docs:

chore:

refactor:

(avoid vague

wip

Examples:

feat(zsh): add zinit plugins

fix(tmux): correct 256‑color setting

PRs should include: purpose, affected packages, OS/terminal version, and before/after notes or screenshots if visual.

Security & Configuration Tips

Do not commit secrets, tokens, or machine‑specific absolute paths.
Guard optional tools (e.g., Homebrew) with checks as in
```
zsh/.zshrc
```
.
Prefer environment variables and local overrides to keep the repo portable.

Repository Guidelines

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines

Security & Configuration Tips

Related Skills

Markdown Converter

Nano Banana Pro

1password

Repository Guidelines

Project Structure & Module Organization

Build, Test, and Development Commands

Coding Style & Naming Conventions

Testing Guidelines

Commit & Pull Request Guidelines

Security & Configuration Tips