docs: add Windows long-path support instructions to README and CONTRIBUTING

PraveenMudalgeri · PraveenMudalgeri · commit 4407601332e7 · 2025-08-19T12:09:15.000+05:30
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto eol=lf
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -80,3 +80,21 @@ If you write a new end to end (e2e) test, or change behaviors that affect e2e te
 2. Run the unit tests. In the root directory of the main repo, run ```python -m unittest discover```.
 
 3. Check the test results and make corresponding fixes.
+
+## Windows Setup Tips
+
+### Enable Long Paths on Windows
+If you’re on Windows and working with deeply nested files or packages:
+
+1. Open PowerShell as Administrator.
+
+2. Run:
+
+```powershell
+New-ItemProperty -Path "HKLM:SYSTEMCurrentControlSetControlFileSystem" `
+  -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+```
+
+3. Reboot your machine.
+
+This ensures tools like `pip install -e .` and tests won’t break on long Windows paths.
diff --git a/README.md b/README.md
@@ -255,4 +255,15 @@ logging.basicConfig(level=logging.DEBUG)
 logging.getLogger("urllib3").setLevel(logging.DEBUG)
 ```
 
+## Windows Long Path Support
+Due to Windows’ default MAX_PATH limit of 260 characters, deeply nested directories may fail.
+To avoid issues, enable long-path support:
+
+```powershell
+# Run as Administrator
+New-ItemProperty -Path "HKLM:SYSTEMCurrentControlSetControlFileSystem" `
+  -Name "LongPathsEnabled" -Value 1 -PropertyType DWORD -Force
+```
+After reboot, Windows will allow paths longer than 260 characters.
+
 **[⬆ back to top](#Installation)**
