From 72a924ebd7abdfa2c51f8c00b3cbd130b059ca3e Mon Sep 17 00:00:00 2001 From: Ben Sima Date: Sat, 22 Nov 2025 14:04:50 -0500 Subject: feat: implement t-1o2bkufixnc Refactored `AGENTS.md` to be a concise cheat sheet by: 1. Moving detailed examples of "Forbidden Patterns" and "Bug Discovery" to `Omni/Task/README.md`. 2. Moving "Coding Conventions" (Always include tests, No TODOs, Fast typechecking) to `README.md`. 3. Removing "About Omnirepo" and "Source Layout" sections from `AGENTS.md` as they are duplicative of `README.md`. 4. Condensing `AGENTS.md` to contain only Critical Rules, a short Session Checklist/Cheat Sheet, and pointers to the detailed READMEs (`Omni/Task/README.md`, `Omni/Bild/README.md`, `Omni/Ide/README.md`, `README.md`). Verified that detailed documentation exists in the respective namespaces and passed linting. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 2554aff..f9aefab 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,12 @@ use. convention `if __name__ == "__main__"` is not necessary because `bild` wraps the program in a call like `python -m main`; the same is true of Guile scheme. +3. **Always include tests**: Every new feature and bug fix must include tests. No + code should be committed without corresponding test coverage. +4. **No TODO/FIXME comments**: Instead of leaving TODO or FIXME comments in code, + create a task with `task create` to track the work properly. +5. **Fast typechecking**: Use `Omni/Ide/typecheck.sh ` for quick Python + typechecking instead of `bild --test` when you only need to check types. ## Setting up remote builds -- cgit v1.2.3