diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..24eb66bb --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,16 @@ +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 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. +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.