From 05a18edc549a5090f237620975044da7eb0bde99 Mon Sep 17 00:00:00 2001 From: Stefan Haller Date: Sun, 9 Mar 2025 17:38:59 +0100 Subject: [PATCH] Add hint to not copy the whole defaults section into the config file I'm not mentioning *why* it's not a good idea, and I'm not sure it's important to explain this to users. I'll say it here: - it exposes users to potential bugs like the one described in the previous commit - if we decide to change the default of an option to something "better" (like we did with the "show graph" setting), users don't benefit from what we think is an improvement for most users --- docs/Config.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/Config.md b/docs/Config.md index 7ffeca39f..044ba10ea 100644 --- a/docs/Config.md +++ b/docs/Config.md @@ -31,6 +31,8 @@ to the top of your config file or via [Visual Studio Code settings.json config][ ## Default +This is only meant as a reference for what config options exist, and what their default values are. It is not meant to be copied and pasted into your config file as a whole; that's not a good idea for several reasons. It is recommended to include only those settings in your config file that you actually want to change. + ```yaml # Config relating to the Lazygit UI