Skip to content

Commit ddf0534

Browse files
committed
fix: update CONTRIBUTING.md to use Bun instead of npm
- Changed npm install to bun install - Changed npm run build to bun run build - Added explicit warning about using Bun exclusively
1 parent 9d30050 commit ddf0534

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,18 @@ pip install -r requirements.txt
1717
cp .env.example .env
1818
# Add your API keys to .env
1919

20-
# Set up frontend
20+
# Set up frontend (MUST use Bun, not npm!)
2121
cd ../frontend
22-
npm install
22+
bun install
2323

2424
# Run tests
2525
cd ../backend
2626
pytest tests/ -v
2727
```
2828

29+
> **Important:** The frontend uses Bun exclusively. Do NOT use npm or yarn.
30+
> Install Bun: `curl -fsSL https://bun.sh/install | bash`
31+
2932
## How to Contribute
3033

3134
### Reporting Bugs
@@ -65,7 +68,7 @@ pytest tests/ -v
6568
- Use TypeScript strict mode
6669
- Prefer functional components
6770
- Use Tailwind for styling
68-
- Run: `npm run build` to check for errors
71+
- Run: `bun run build` to check for errors
6972

7073
## Testing
7174

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,9 @@ python -m venv venv && source venv/bin/activate
123123
pip install -r requirements.txt
124124
python main.py
125125

126-
# Frontend (new terminal)
126+
# Frontend (new terminal) - MUST use Bun!
127127
cd frontend
128-
npm install && npm run dev
128+
bun install && bun run dev
129129
```
130130

131131
</details>

0 commit comments

Comments
 (0)