docs: Ask before running fmt

fmt reindents non-canonically-formatted files wholesale, burying logical changes in whitespace churn. Note to match surrounding style by hand. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-20 16:11:25 +01:00
parent 823ed83252
commit dc1ec3bf5a
1 changed files with 3 additions and 0 deletions
@@ -127,6 +127,9 @@ private keys) is required for editing secrets, deploying, and running dev VMs.
 ## Conventions

 - Format with `nixpkgs-fmt` (`fmt`). 2-space indent, `inherit (...)` blocks at the top of `let`.
+  **Ask before running `fmt`** — some files aren't canonically formatted, so `fmt` can reindent a
+  whole file and bury a logical change in whitespace churn. Match the surrounding style by hand and
+  leave formatting to the user unless they ask.
 - Prefer `lib.my` helpers (`mkOpt'`, `mkBoolOpt'`, `mkDefault'`) and `lib.my.c` constants over
  reimplementing.
 - New shared functionality → a module in `*/modules/` + entry in `_list.nix`, options under `my.*`.