Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Environment/Tools

* Python project with `uv`, use `uv add`/`uv run python` instead of bare `pip`/`python`
* `poe setup`: One-time after-clone setup (dependencies, install pre-commit hooks).
* `poe lint`: Pre-commit hooks (via `pre-commit`-compatible `prek`) including lint, format, type check (ruff, ty)
* `poe test`: Run tests (accepts pytest arguments)
* `poe lt`: Lint+test (no arguments)
* `poe snapup`: Update test snapshots (syrupy, accepts pytest arguments)
9 changes: 9 additions & 0 deletions template/AGENTS.md.jinja
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Environment/Tools

* Python project with `uv`, use `uv add`/`uv run python` instead of bare `pip`/`python`
* `poe setup`: One-time after-clone setup (dependencies, install pre-commit hooks).
* `poe lint`: Pre-commit hooks (via `pre-commit`-compatible `prek`) including lint, format, type check (ruff, ty)
* `poe test`: Run tests (accepts pytest arguments)
* `poe lt`: Lint+test (no arguments)
* `poe snapup`: Update test snapshots (syrupy, accepts pytest arguments)
{#- vim: set ft=markdown: #}
14 changes: 14 additions & 0 deletions tests/__snapshots__/test_agents.ambr
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# serializer version: 1
# name: test_agents
'''
# Environment/Tools

* Python project with `uv`, use `uv add`/`uv run python` instead of bare `pip`/`python`
* `poe setup`: One-time after-clone setup (dependencies, install pre-commit hooks).
* `poe lint`: Pre-commit hooks (via `pre-commit`-compatible `prek`) including lint, format, type check (ruff, ty)
* `poe test`: Run tests (accepts pytest arguments)
* `poe lt`: Lint+test (no arguments)
* `poe snapup`: Update test snapshots (syrupy, accepts pytest arguments)

'''
# ---
13 changes: 13 additions & 0 deletions tests/test_agents.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""Snapshot tests for AGENTS.md template."""

from collections.abc import Callable
from pathlib import Path

from syrupy.assertion import SnapshotAssertion


def test_agents(
render_template: Callable[..., Path], snapshot: SnapshotAssertion
) -> None:
rendered = render_template()
assert (rendered / "AGENTS.md").read_text() == snapshot
Loading