docs: update info about merge order (#838)

* docs: update info about merge order * docs: add a summary
evilmartians · Oct 10, 2024 · 468bf01 · 468bf01
1 parent 1c92f5b
commit 468bf01
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -150,6 +150,16 @@ extends:
   - ../extend.yml
 ```
 
+> [!IMPORTANT]
+> The extends will be merged to the main configuration in your file. Here is the order of settings applied:
+>
+> - `lefthook.yml` – main config file
+> - `extends` – configs specified in [extends](#extends) option
+> - `remotes` – configs specified in [remotes](#remotes) option
+> - `lefthook-local.yml` – local config file
+>
+> So, `extends` override settings from `lefthook.yml`, `remotes` override `extends`, and `lefthook-local.yml` can override everything.
+
 ### `min_version`
 
 If you want to specify a minimum version for lefthook binary (e.g. if you need some features older versions don't have) you can set this option.