summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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