summaryrefslogtreecommitdiffhomepage
path: root/STYLE_GUIDE.md
diff options
context:
space:
mode:
Diffstat (limited to 'STYLE_GUIDE.md')
-rw-r--r--STYLE_GUIDE.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md
new file mode 100644
index 000000000..164f69bd4
--- /dev/null
+++ b/STYLE_GUIDE.md
@@ -0,0 +1,12 @@
+## Style Guide
+
+- Try to keep things in one function unless composable or reusable
+- DO NOT do unnecessary destructuring of variables
+- DO NOT use `else` statements unless necessary
+- DO NOT use `try`/`catch` if it can be avoided
+- AVOID `try`/`catch` where possible
+- AVOID `else` statements
+- AVOID using `any` type
+- AVOID `let` statements
+- PREFER single word variable names where possible
+- Use as many bun apis as possible like Bun.file()