Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (35 loc) · 1000 Bytes

CONTRIBUTING.md

File metadata and controls

49 lines (35 loc) · 1000 Bytes

Contributing

Thanks for improving these dotfiles.

Local Setup

git clone https://github.com/SmartMur/dotfiles.git
cd dotfiles
./install.sh --skip-brew

Install local hooks once:

brew install pre-commit
pre-commit install

Required Checks Before PR

bash -n bootstrap.sh
bash -n install.sh
pre-commit run --all-files
python3 scripts/security_scrub.py --no-history

For security-sensitive changes, also review docs/SECURITY_RULEBOOK.md.

If you changed Brewfile, also verify:

brew bundle check --file Brewfile || true

Contribution Rules

  • Keep changes focused and reversible.
  • Do not commit secrets, tokens, private keys, or machine-specific credentials.
  • Preserve backup-safe behavior in install.sh.
  • Document user-facing changes in README.md and CHANGELOG.md.
  • Follow docs/SECURITY_RULEBOOK.md incident flow if any leakage is detected.

PR Checklist

  • What changed and why
  • How it was tested
  • Risk notes (if any)