From 8c90b3e56fcb74d364cbad735af113a1ee4f65b1 Mon Sep 17 00:00:00 2001
From: Christopher Bartz <christopher.bartz@canonical.com>
Date: Fri, 8 Mar 2024 10:45:45 +0100
Subject: [PATCH] Add src-docs instructions

---
 CONTRIBUTING.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 288f021..97dbb61 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -9,6 +9,15 @@ tox devenv -e integration
 source venv/bin/activate
 ```
 
+## Generating src docs for every commit
+
+Run the following command:
+
+```bash
+echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```
+
 ## Testing
 
 This project uses `tox` for managing test environments. There are some pre-configured environments