From 5daeceda3372fe70530de69bf263bde73daf1163 Mon Sep 17 00:00:00 2001 From: Mitzi Morris Date: Tue, 15 Sep 2026 09:40:02 -0400 Subject: [PATCH 1/3] prelim AGENTS.md instructions for codex --- AGENTS.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..51fe97c3 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,14 @@ +Functions, classes, and packages designs should be straightforward. +The code needs to be clean and human-readable and human-maintainable. +Factor repeated computation into general functions. +Avoid overly general and extensible frameworks. +Always ask if a design or code change requires backwards compatibility. +In most cases, backwards compatibility is not a concern. + +coding style: always use MyPy type hints. all functions should have a docstring; public-facing API functions should be user-focussed. users want to know what the function does, ditto maintainers. omit design discussion details. + inline comments only for critical, non-obvious details. + +Design and implementation plans should be written in plain style. +describe math in terms of python computation. + +I will commit and push edited files to GitHub myself - do not commit or push unless I tell you to. From 19453420c8df2e28a54e65d92c3121af2ba34c54 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 15 Sep 2026 13:41:53 +0000 Subject: [PATCH 2/3] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- AGENTS.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 51fe97c3..bdaae94b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -5,8 +5,11 @@ Avoid overly general and extensible frameworks. Always ask if a design or code change requires backwards compatibility. In most cases, backwards compatibility is not a concern. -coding style: always use MyPy type hints. all functions should have a docstring; public-facing API functions should be user-focussed. users want to know what the function does, ditto maintainers. omit design discussion details. - inline comments only for critical, non-obvious details. +coding style: always use MyPy type hints. +all functions should have a docstring; public-facing API functions should be user-focussed. +users want to know what the function does, ditto maintainers. +omit design discussion details. +inline comments only for critical, non-obvious details. Design and implementation plans should be written in plain style. describe math in terms of python computation. From 562fc33e1a83932431be6fc8ee1c1ec9e099c0c6 Mon Sep 17 00:00:00 2001 From: Mitzi Morris Date: Tue, 15 Sep 2026 14:39:06 -0400 Subject: [PATCH 3/3] Update AGENTS.md Co-authored-by: Damon Bayer --- AGENTS.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index bdaae94b..24eb66bb 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -7,8 +7,7 @@ In most cases, backwards compatibility is not a concern. coding style: always use MyPy type hints. all functions should have a docstring; public-facing API functions should be user-focussed. -users want to know what the function does, ditto maintainers. -omit design discussion details. +users and developers want to know what the function does, not design details. inline comments only for critical, non-obvious details. Design and implementation plans should be written in plain style.