From dc1ec3bf5ab8162af826184c8a02778db8af3af5 Mon Sep 17 00:00:00 2001 From: Jack O'Sullivan Date: Mon, 20 Jul 2026 16:11:25 +0100 Subject: [PATCH] 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 --- AGENTS.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index fe5d1d2..a216842 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -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.*`.