summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Sima <ben@bensima.com>2025-11-22 14:04:50 -0500
committerBen Sima <ben@bensima.com>2025-11-22 14:04:50 -0500
commit72a924ebd7abdfa2c51f8c00b3cbd130b059ca3e (patch)
tree500a07aa2f3634fa2153a8dd0a1e27fa40d5c1af /README.md
parent67dd152e40a3f08e5a7aaaaf4cc9b1122e6b6909 (diff)
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.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
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 <file>` for quick Python
+ typechecking instead of `bild --test` when you only need to check types.
## Setting up remote builds