Add a warning about adding new config options

This commit is contained in:
Stefan Haller
2026-04-13 14:09:08 +02:00
parent 600ff21b47
commit 913e118d12
+1
View File
@@ -45,6 +45,7 @@ The git CLI is very complex but most git use cases are simple. Lazygit needs to
- Don't overwhelm the user with options
- Use sensible defaults
- We already have too many configuration options: think hard before adding any new ones
- A bit of elaboration on this one: in the past we made the mistake of adding new config options all the time for unimportant things. The thinking was: one user wants to have this new feature or behavior, we are not sure if everybody will like it, so we hide it behind a config. This seems good because we satisfy everybody's needs, but it's bad because if Config.md is pages and pages of text, most users will not bother reading all of it, so they won't be aware of the actually useful options among all the obscure ones. We should be much more conservative about adding new config options that only few users are likely to use.
### Safety