From 9845f908508235d350b2355c6c4ff8966ee039bc Mon Sep 17 00:00:00 2001
From: Munish Mummadi <moneymindedmunish1@gmail.com>
Date: Thu, 13 Mar 2025 19:54:09 -0500
Subject: [PATCH] feat: added a pain point i faced

---
 node-hub/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/node-hub/README.md b/node-hub/README.md
index 9dd0d5c6..e1301030 100644
--- a/node-hub/README.md
+++ b/node-hub/README.md
@@ -98,6 +98,28 @@ dev = ["pytest >=8.1.1", "ruff >=0.9.1"]
 opencv-plot = "opencv_plot.main:main"
 
 ```
+## Adding git dependency
+- If a git repository is added as submodule. Proper path should be added in `pyproject.toml` inorder to make sure that linting and testing are exempted for that dependency. 
+- A very good example of how this can be done is as follows
+
+Correct approach:
+```toml
+[tool.ruff]
+exclude = ["dora_magma/Magma"]
+
+[tool.black]
+extend.exclude = "dora_magma/Magma"
+```
+Incorrect Approach:
+```toml
+[tool.ruff]
+exclude = ["dora-magma/dora_magma/Magma"]
+
+[tool.black]
+extend.exclude = "dora_magma/Magma"
+```
+##### Note: 
+- `dora-magma` is root folder of the node. 
 
 ## License