Skip to content

Commit 46962c2

Browse files
authored
chore: Add AGENTS.md (#567)
* Also Add CLAUDE.md with a pointer to AGENTS.md as a temporary workaround for the lack of support of AGENTS.md in claude code
1 parent 121a9b0 commit 46962c2

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

AGENTS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
- Only generate docstrings for public functions or functions that contain more than 4 lines of code.
2+
- Use the Sphinx style for Python docstrings (e.g. :param my_param: Does something) and never
3+
include a :returns: key.
4+
- The code you generate should always contain type hints in the function prototypes (including
5+
return type hints of None), but type hints are not needed when initializing variables.
6+
- We use uv for everything (e.g. we do `uv run python ...` to run some python code, and
7+
`uv run pytest tests/unit` to run unit tests). Please prefer `uv run python -c ...` over
8+
`python3 -c ...`
9+
- After generating code, please run `uv run ty check`, `uv run ruff check` and `uv run ruff format`.
10+
Fix any error.
11+
- After changing anything in `src` or in `tests/unit` or `tests/doc`, please identify the affected
12+
test files in `tests/` and run them with e.g.
13+
`uv run pytest tests/unit/aggregation/test_upgrad.py -W error`. Fix any error, either in the
14+
changes you've made or by adapting the tests to the new specifications.

CLAUDE.md

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

0 commit comments

Comments
 (0)