Skip to content

Commit ca99c5e

Browse files
Add AGENTS.md
1 parent 96907a2 commit ca99c5e

3 files changed

Lines changed: 23 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Repository Guidance
2+
3+
See [README.md](README.md) for contributor setup.
4+
5+
## Tests
6+
7+
Before wrapping up a change, run the relevant validation commands from the
8+
README:
9+
10+
```zsh
11+
tox --parallel # Test all Python versions
12+
tox -e py310 # Test specific Python version
13+
ruff format . # Format code
14+
```
15+
16+
Prefer the minimum Python version while iterating, `tox -e py310`. Then use
17+
broader validation when the scope of the change warrants it.
18+
19+
Most `tox` environments forward to `pytest`. To focus one environment's tests,
20+
use a `pytest` selector such as `tox -e py310 -- -k private`, or run a specific
21+
test file such as `tox -e py310 -- tests/cli_test.py`.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AGENTS.md

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ See [URL validation](#url-validation) and
196196

197197
```zsh
198198
tox --parallel # Test all Python versions
199-
tox -e py311 # Test specific Python version
199+
tox -e py310 # Test specific Python version
200200
ruff format . # Format code
201201
```
202202

0 commit comments

Comments
 (0)