Skip to content

Commit 5e1ab3c

Browse files
Merge pull request #5029 from karthik-kotra/docs/setup-troubleshooting
docs(setup): add troubleshooting steps for common WSL setup issues
2 parents 402bb38 + 41cd11d commit 5e1ab3c

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,52 @@ You may submit PRs without prior assignment for:
6565
6666
> **Tip:** Installing Claude Code skills is optional for running existing agents, but required if you plan to **build new agents**.
6767
68+
## Troubleshooting Setup Issues
69+
70+
If you encounter issues while setting up the development environment, the following steps may help:
71+
72+
### `make: command not found`
73+
Install `make` using:
74+
75+
```bash
76+
sudo apt install make
77+
78+
uv: command not found
79+
80+
Install uv using:
81+
82+
curl -LsSf https://astral.sh/uv/install.sh | sh
83+
source ~/.bashrc
84+
85+
ruff: not found
86+
87+
If linting fails due to a missing ruff command, install it with:
88+
89+
uv tool install ruff
90+
91+
WSL Path Recommendation
92+
93+
When using WSL, it is recommended to clone the repository inside your Linux home directory (e.g., ~/hive) instead of under /mnt/c/... to avoid potential performance and permission issues.
94+
95+
96+
---
97+
98+
# ✅ Why This Is Good
99+
100+
- Clear
101+
- Professional tone
102+
- No unnecessary explanation
103+
- Under micro-fix size
104+
- Based on real contributor experience
105+
- Won’t annoy maintainers
106+
107+
---
108+
109+
Now:
110+
111+
```bash
112+
git checkout -b docs/setup-troubleshooting
113+
68114
## Commit Convention
69115
70116
We follow [Conventional Commits](https://www.conventionalcommits.org/):

0 commit comments

Comments
 (0)