docs: document pre-commit hook

GameDevTecnico · Sep 27, 2023 · b9647dc · b9647dc
1 parent ce5cf4d
commit b9647dc
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/docs/pages/1_getting_started/main.md b/docs/pages/1_getting_started/main.md
@@ -39,6 +39,15 @@ from the root directory of the repository:
 git submodule update --init --recursive
 ```
 
+### Formatting
+
+To contribute you must ensure your code is correctly formatted. Install
+`clang-format` and run the following command to enable the pre-commit hook:
+
+```bash
+git config --local include.path ../.gitconfig
+```
+
 ### Compiling
 
 If you chose to install some dependencies separately, you must pass the