add code design

2021-10-24 13:12:45 +08:00 · 2021-10-24 13:12:45 +08:00 · 29145604be
parent 21f8789b27
commit 29145604be
1 changed files with 13 additions and 0 deletions
--- a/docs/code_design.md
+++ b/docs/code_design.md
@ -0,0 +1,13 @@
+# Code Design
+
+## Code Organization
+
+1. Every function except `main.ts` should be pure. Pass any stateful information in parameters.
+
+2. `misc.ts` should not depend on any other written code.
+
+3. Each storage code should not depend on `sync.ts`.
+
+## File and Folder Representation
+
+While writing sync codes, folders are always represented by a string ending with `/`.