Skip to content

Commit 1d03d10

Browse files
authored
docs: add CONTRIBUTING.md (#119)
1 parent e893bd6 commit 1d03d10

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing
2+
3+
## Setup
4+
5+
```bash
6+
git clone https://github.com/YOUR_USERNAME/next-ai-draw-io.git
7+
cd next-ai-draw-io
8+
npm install
9+
cp env.example .env.local
10+
npm run dev
11+
```
12+
13+
## Code Style
14+
15+
We use [Biome](https://biomejs.dev/) for linting and formatting:
16+
17+
```bash
18+
npm run format # Format code
19+
npm run lint # Check lint errors
20+
npm run check # Run all checks (CI)
21+
```
22+
23+
Pre-commit hooks via Husky will run Biome automatically on staged files.
24+
25+
For a better experience, install the [Biome VS Code extension](https://marketplace.visualstudio.com/items?itemName=biomejs.biome) for real-time linting and format-on-save.
26+
27+
## Pull Requests
28+
29+
1. Create a feature branch
30+
2. Make changes and ensure `npm run check` passes
31+
3. Submit PR against `main` with a clear description
32+
33+
## Issues
34+
35+
Include steps to reproduce, expected vs actual behavior, and AI provider used.

0 commit comments

Comments
 (0)