Skip to content

Commit e32d349

Browse files
docs: add initial AGENTS.md (#29)
* Initial plan * docs: create initial AGENTS.md noting uv package management Co-authored-by: deviantintegral <255023+deviantintegral@users.noreply.github.com> * docs: install pre-commit Added instructions for installing pre-commit hooks. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: deviantintegral <255023+deviantintegral@users.noreply.github.com> Co-authored-by: Andrew Berry <andrew@furrypaws.ca>
1 parent de9c716 commit e32d349

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Agents
2+
3+
## Package Management
4+
5+
This project uses [`uv`](https://docs.astral.sh/uv/) for package management. Do **not** use `pip` directly.
6+
7+
Install dependencies with:
8+
9+
```bash
10+
uv sync --dev
11+
```
12+
13+
Add packages with:
14+
15+
```bash
16+
uv add <package>
17+
```
18+
19+
## Development
20+
21+
```bash
22+
# Install pre-commit hooks.
23+
uv run pre-commit install
24+
25+
# Lint and type-check
26+
uv run ruff check .
27+
uv run mypy src/
28+
29+
# Run tests
30+
uv run pytest
31+
```

0 commit comments

Comments
 (0)