Merge pull request #13 from canonical/add-src-docs

Add src-docs instructions
canonical · Mar 8, 2024 · 6ec5375 · 6ec5375
2 parents 59b6ac9 + 8c90b3e
commit 6ec5375
Showing 1 changed file with 9 additions and 0 deletions.
diff --git 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