Skip to content

Commit e9fbc47

Browse files
docs: add CONTRIBUTING.md with lint/format instructions
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 3b4990c commit e9fbc47

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Setup
4+
5+
```bash
6+
uv sync
7+
```
8+
9+
## Before committing
10+
11+
```bash
12+
uv run ruff check src/ tests/ # lint
13+
uv run ruff format src/ tests/ # format
14+
uv run pytest tests/test_client.py -v # tests
15+
```
16+
17+
Or all at once:
18+
19+
```bash
20+
uv run ruff check src/ tests/ && uv run ruff format src/ tests/ && uv run pytest tests/test_client.py -v
21+
```
22+
23+
CI will reject PRs that fail lint or format checks.
24+
25+
## Running integration tests
26+
27+
Requires `SGAI_API_KEY` env var:
28+
29+
```bash
30+
uv run pytest tests/test_integration.py -v
31+
```

0 commit comments

Comments
 (0)