Skip to content

Commit 05a18ed

Browse files
committed
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
1 parent 95940ee commit 05a18ed

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/Config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ to the top of your config file or via [Visual Studio Code settings.json config][
3131

3232
## Default
3333

34+
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.
35+
3436
<!-- START CONFIG YAML: AUTOMATICALLY GENERATED with `go generate ./..., DO NOT UPDATE MANUALLY -->
3537
```yaml
3638
# Config relating to the Lazygit UI

0 commit comments

Comments
 (0)