Skip to content

Commit 33f1a3e

Browse files
Clarify agent setup and workflow details
1 parent dd6db0e commit 33f1a3e

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

.github/AGENTS.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,18 @@ This repository provides Python bindings for the Rust library `egglog`, enabling
2424

2525
### Prerequisites
2626
- **uv** - Package manager (https://github.com/astral-sh/uv)
27-
- **Rust toolchain** - See rust-toolchain.toml for version
28-
- **Python** - See .python-version for version
27+
- **Rust toolchain** - Version pinned in `rust-toolchain.toml`
28+
- **Python** - Version pinned in `.python-version`
2929

3030
### Common Commands
3131

3232
```bash
3333
# Install dependencies
3434
uv sync --all-extras
3535

36+
# Reinstall the Rust extension after changing code in `src/`
37+
uv sync --reinstall-package egglog --all-extras
38+
3639
# Run tests
3740
uv run pytest --benchmark-disable -vvv --durations=10
3841

@@ -45,6 +48,10 @@ make stubtest
4548
# Build documentation
4649
make docs
4750

51+
# Refresh the bundled visualizer assets
52+
make clean
53+
make
54+
4855
# Format code (auto-run by pre-commit)
4956
uv run ruff format .
5057

@@ -125,6 +132,10 @@ The `egglog.bindings` module provides lower-level access to the Rust implementat
125132
- `python/egglog/ipython_magic.py` - IPython/Jupyter integration
126133
- `python/egglog/visualizer_widget.py` - Interactive visualization widget
127134
- `python/egglog/version_compat.py` - Python version compatibility utilities
135+
- `python/egglog/examples/` - End-to-end samples and tutorials demonstrating the API
136+
- `python/egglog/exp/` - Experimental Array API integrations and code generation helpers
137+
138+
The compiled extension artifact `python/egglog/bindings.cpython-*.so` is generated by `uv sync` and should not be edited manually.
128139

129140
## Code Style Preferences
130141

@@ -144,7 +155,7 @@ When making changes:
144155
4. Build documentation if changing public APIs
145156
5. Follow existing code patterns and style
146157
6. Keep changes minimal and focused
147-
7. Add a changelog entry in `docs/changelog.md` under the UNRELEASED section
158+
7. Ensure the automatic changelog entry in `docs/changelog.md` (added when opening the PR) accurately reflects your change and add manual notes if additional clarification is needed
148159

149160
## Common Patterns
150161

0 commit comments

Comments
 (0)