Dotfiles Commit Workflow

Pre-commit Checklist

Before every commit, run these in order:

•
Run the test suite:
bash
```
bash ~/test-dotfiles.sh
```

•

Run markdown lint on all docs:

bash

npx markdownlint-cli '**/*.md' --ignore node_modules

•
Fix ALL lint errors before proceeding — no exceptions.

Common Markdownlint Errors

•MD022: Headings need blank lines above and below
•MD031: Code blocks need blank lines above and below
•MD032: Lists need blank lines above and below
•MD013: Keep lines under 80 characters when possible

Yadm Commands (NOT git)

All operations use yadm, never git:

bash

yadm status           # Check status
yadm diff             # View changes
yadm add <file>       # Stage file
yadm commit -m "msg"  # Commit
yadm push             # Push to GitHub

Author Configuration

Verify before first commit in a session:

bash

yadm config user.name   # Should be: Tzu-Hua(Nick) Liu
yadm config user.email  # Should be: nickboy@users.noreply.github.com

Set if missing:

bash

yadm config user.name "Tzu-Hua(Nick) Liu"
yadm config user.email "nickboy@users.noreply.github.com"

Conventional Commit Format

Use these prefixes:

•feat: — New features
•fix: — Bug fixes
•docs: — Documentation changes
•test: — Test additions or changes
•refactor: — Code refactoring
•style: — Formatting changes
•chore: — Maintenance tasks

Example: yadm commit -m "feat: add tmux session management script"

Commit Rules

•Do NOT include Claude co-author or AI-generated tags
•Do NOT use git — always use yadm
•Every commit MUST pass markdown linting
•Run bash ~/test-dotfiles.sh before committing

Pull Request Workflow

bash

# Create feature branch
yadm checkout -b feature/branch-name

# Make changes, test, commit
bash ~/test-dotfiles.sh
npx markdownlint-cli '**/*.md' --ignore node_modules
yadm add <files>
yadm commit -m "feat: description"

# Push branch
yadm push -u origin feature/branch-name

# Create PR
yadm pr create --title "PR title" --body "PR description"

If the pr alias is not configured:

bash

yadm gitconfig alias.pr '!f() { GIT_DIR=$HOME/.local/share/yadm/repo.git \
  GIT_WORK_TREE=$HOME gh pr "$@"; }; f'

Other PR operations:

bash

yadm pr list              # List PRs
yadm pr view              # View current PR
yadm pr merge             # Merge PR